https://github.com/konstantinsimeonov/fluent-schemer
i wrote this so i can validate stuff without suffering
https://github.com/konstantinsimeonov/fluent-schemer
declarative javascript schema-validation validation validation-library
Last synced: about 1 year ago
JSON representation
i wrote this so i can validate stuff without suffering
- Host: GitHub
- URL: https://github.com/konstantinsimeonov/fluent-schemer
- Owner: KonstantinSimeonov
- License: mit
- Created: 2017-01-21T00:23:03.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2018-09-27T23:25:15.000Z (over 7 years ago)
- Last Synced: 2025-04-29T05:47:55.327Z (about 1 year ago)
- Topics: declarative, javascript, schema-validation, validation, validation-library
- Language: JavaScript
- Homepage:
- Size: 502 KB
- Stars: 47
- Watchers: 4
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# fluent-schemer
```js
const librarySchema = object({
dependenciesCount: number().min(0).max(10).integer().optional(),
name: string().minlength(2).maxlength(10),
testCoverage: number().min(0).max(100).optional(),
lastCommitDate: date().after(new Date(new Date().setMonth(new Date().getMonth() - 1))),
contributors: array(
object({
username: string().minlength(5),
email: string().pattern(/\S+@\S+\.\S+/)
})
),
issues: array(string()),
activelyMaintained: bool(),
license: enumeration('MIT', 'BSD', 'GPL')
});
const { errorCounts, errors } = librarySchema.validate(someLibraryRecord);
```
## Incoming:
- **default values**, something like
```ts
const { corrected: pageSize } = number().min(10).max(100).integer().default(10).validate(-5);
console.log(corrected); // 10
const { corrected: username } = string()
.minlength(2)
.maxlength(10)
.defaultExpression(value => ('_________' + value).slice(0, 10))
.validate('1');
console.log(username); // _________1
```
Aims to provide declarative, expressive and elegant approach to validation, while providing an intuitive, easy-to-use api.
## It's cool, because
- it **fully embraces ES2015** features such as classes, fat arrow functions, mixins, destructuring statements, modules
- has **typescript type definitions** - v2.0 comes with typings for enhanced development experience
- has **flow libdefs**, which will soon be available on flow-typed
- **easy to use and pick up**, write a little code for a lot of common validation logic
- has a **fluent, readable and declarative** api
- **umd compliant** - use in node/browser, with commonjs, umd, script tags, harmony modules, whatever
- **no production dependencies**, small codebase
- helps developers **get rid of imperative code, long if-else's** and writing boring validations all over again
- **promotes code reuse** - easily share code between modules, between clients, servers and across projects
- easy to extends with custom schemas
- **statically type checked** with latest typescript, checked for correctness with a bunch of **unit tests**
- **throws errors when rubbish arguments are provided** to schema methods, instead of failing silently
### Running the tests
```
yarn build && yarn lint && yarn test
```
### Examples
Examples can be found in the [docs](./docs), in the source code and in the tests.
## [Documentation](./docs/QUICKSTART.md)