Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fchauvel/quick-check
Quick validation and convertion of JSON structures
https://github.com/fchauvel/quick-check
Last synced: 13 days ago
JSON representation
Quick validation and convertion of JSON structures
- Host: GitHub
- URL: https://github.com/fchauvel/quick-check
- Owner: fchauvel
- License: mit
- Created: 2020-01-24T08:32:06.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2020-02-02T21:20:21.000Z (almost 5 years ago)
- Last Synced: 2024-10-05T21:06:51.161Z (3 months ago)
- Language: TypeScript
- Size: 76.2 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Quick-check
[](https://www.npmjs.com/package/@fchauvel/quick-check)
[](https://www.npmjs.com/package/@fchauvel/quick-check)
[](https://travis-ci.org/fchauvel/quick-check)
[](https://codecov.io/gh/fchauvel/quick-check/)
[](https://app.codacy.com/manual/fchauvel/quick/dashboard)
Quick-check is small Javascript library to express JSON schema
directly in the code, parse and convert objects into custom classes.
Checkout the [documentation](https://fchauvel.github.io/quick-check/index.html).
## Schema Declaration
Quick-check let us declare data schema in a readable manner that reduces the need for documentation.
```typescript
const schema = new Grammar();
schema.define("team")
.as(anObject()
.with(aProperty("name").ofType("string"))
.with(aProperty("members")
.ofType(anArrayOf(eitherOf("person", "team")))));
schema.define("person")
.as(anObject()
.with(aProperty("firstname")
.ofType("string")
.withDefault("Unknown"))
.with(aProperty("lastname").ofType("string")));
```
## Validation
We can now check whether the data we get from JSON or YAML file adhere
to our schema.
```typescript {highlight: \[4]}
const fileContent = fs.readFileSync('./data.yaml', 'utf8');
const data = yaml.safeLoad(fileContents);
try {
const myTeam = schema.read(data).as("team");
} catch (report) {
console.log(report.toString());
}
```
## Convertion
We can also equip our type definitions with convertion rules to obtain
objects instance of specific home-grown classes.
```typescript
schema.on("team").apply((data) => {
return new Team(data.name, data.members);
});
schema.on("person").apply((data) => {
return new Person(data.firstname, data.lastname);
});
const myTeam = schema.read(data).as("team");
console.log(myTeam.members[1].members[0].name);
```
## Features
- [x] Convertion
- [ ] Validation
- [x] Booleans
- [ ] Integers
- [x] even
- [x] odd
- [x] a multiple of
- [x] a power of
- [ ] Numbers
- [x] Strictly greater than
- [x] Greater than
- [x] Strictly smaller than
- [x] Smaller than
- [x] Is positive
- [x] Is negative
- [ ] CloseTo
- [x] Strings
- [x] Not empty
- [x] Match a given pattern
- [x] Start with prefix
- [x] Ends with suffix
- [x] Has length, at least x characters
- [x] Has length, at most x characters
- [x] Arrays
- [x] fixed length
- [x] Length check (at most)
- [x] Length check (at least)
- [x] Uniqueness of element
- [x] Unions
- [ ] Enumerations