Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/akornatskyy/check-compiler-js
:checkered_flag: A typescript-first schema rule compiler and validation library.
https://github.com/akornatskyy/check-compiler-js
check compiler rules schema validation
Last synced: about 1 month ago
JSON representation
:checkered_flag: A typescript-first schema rule compiler and validation library.
- Host: GitHub
- URL: https://github.com/akornatskyy/check-compiler-js
- Owner: akornatskyy
- License: mit
- Created: 2023-03-10T15:27:12.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2024-10-19T08:21:26.000Z (3 months ago)
- Last Synced: 2024-11-20T15:26:36.158Z (about 2 months ago)
- Topics: check, compiler, rules, schema, validation
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/check-compiler
- Size: 404 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# check-compiler-js
[](https://github.com/akornatskyy/check-compiler-js/actions/workflows/tests.yml) [](https://www.npmjs.com/package/check-compiler)
A typescript-first schema rule compiler and validation library.
- no dependencies
- reusable schema definitions
- node.js and browsers
- tiny [minified+gzipped](https://bundlephobia.com/package/check-compiler)
## Install
Enable [strict](https://www.typescriptlang.org/tsconfig#strict) mode in
`tsconfig.json`.
```sh
npm i check-compiler
```
## Usage
Creating a simple string schema:
```ts
import {compile, Rule, Violation} from 'check-compiler';
// define
const id: Rule = {
type: 'string',
min: 8,
max: 8,
pattern: /^[a-z]+$/,
messages: {
'string pattern': 'Required to be lowercase alpha only.',
},
};
// compile
const checkId = compile(id);
// check
const input = 'abcdefgh';
const violations: Violation[] = [];
checkId(input, violations);
```
Creating an object schema:
```ts
import {compile, Rule, Violation} from 'check-compiler';
// type
type ResourceMap = {
cpu?: number | null;
memory?: number | null;
};
// define
const cpu: Rule = {
type: 'number',
nullable: true,
min: 0,
max: 8000,
};
const memory: Rule = {
type: 'number',
nullable: true,
min: 0,
max: 32768,
};
const resourceMap: Rule = {
type: 'object',
nullable: true,
properties: {
cpu,
memory,
},
};
// compile
const checkResourceMap = compile(resourceMap);
// check
const input: ResourceMap = {cpu: 1000, memory: 512};
const violations: Violation[] = [];
checkResourceMap(input, violations);
```
Defining validation by raising `ValidationError`:
```ts
import {compile, Check, Violation} from 'check-compiler';
export class ValidationError extends Error {
constructor(readonly details: Violation[]) {
super('There is one or more validation violations.');
}
}
export function makeAssetValid(check: Check): (input: T) => void {
return (input: T) => {
const violations: Violation[] = [];
check(input, violations);
if (violations.length > 0) {
throw new ValidationError(violations);
}
};
}
// compile
export const assertResourceMap = makeAssetValid(
compile({
type: 'object',
nullable: true,
properties: {
cpu: {type: 'number', nullable: true, min: 0, max: 8000},
memory: {type: 'number', nullable: true, min: 0, max: 32768},
},
}),
);
// assert
const input: ResourceMap = {cpu: 1000, memory: 512};
assertResourceMap(input);
```
Violation details example:
```json
[
{
"location": "cpu",
"message": "The value must fall within the range 0 - 8000.",
"reason": "number range",
"args": {
"min": 0,
"max": 8000
}
}
]
```