kopia lustrzana https://github.com/transitive-bullshit/chatgpt-api
79 wiersze
2.7 KiB
Markdown
79 wiersze
2.7 KiB
Markdown
|
> [!NOTE]
|
||
|
|
> This package is a fork of [@cfworker/json-schema](https://github.com/cfworker/cfworker) which adds [ajv-style coercion](https://ajv.js.org/coercion.html). Coercion can be enabled with a boolean flag.
|
||
|
|
|
||
|
|
# @agentic/json-schema
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
A JSON schema validator that will run on Cloudflare workers. Supports drafts 4, 7, 2019-09, and 2020-12.
|
||
|
|
|
||
|
|
This library is validated against the [json-schema-test-suite](https://github.com/json-schema-org/JSON-Schema-Test-Suite), a series of approximately 4,500 assertions maintained along with the json-schema specification. A small set of test cases are intentionally not supported due to performance constraints or lack of feature use. These list of unsupported features are maintained in [test/unsupported.ts](./test/unsupported.ts). While this library is not the fastest due to lack of code generation, it's consistently among the [most spec compliant](https://json-schema.org/implementations.html#benchmarks).
|
||
|
|
|
||
|
|
## Background
|
||
|
|
|
||
|
|
_Why another JSON schema validator?_
|
||
|
|
|
||
|
|
Cloudflare workers do not have APIs required by [Ajv](https://ajv.js.org/) schema compilation (`eval` or `new Function(code)`).
|
||
|
|
If possible use Ajv in a build step to precompile your schema. Otherwise this library could work for you.
|
||
|
|
|
||
|
|
## Basic usage
|
||
|
|
|
||
|
|
```js
|
||
|
|
import { Validator } from '@cfworker/json-schema'
|
||
|
|
|
||
|
|
const validator = new Validator({ type: 'number' })
|
||
|
|
|
||
|
|
const result = validator.validate(7)
|
||
|
|
```
|
||
|
|
|
||
|
|
## Specify meta schema draft
|
||
|
|
|
||
|
|
```js
|
||
|
|
const validator = new Validator({ type: 'number' }, '4') // draft-4
|
||
|
|
```
|
||
|
|
|
||
|
|
## Add schemas
|
||
|
|
|
||
|
|
```js
|
||
|
|
const validator = new Validator({
|
||
|
|
$id: 'https://foo.bar/baz',
|
||
|
|
$ref: '/beep'
|
||
|
|
})
|
||
|
|
|
||
|
|
validator.addSchema({ $id: 'https://foo.bar/beep', type: 'boolean' })
|
||
|
|
```
|
||
|
|
|
||
|
|
## Include all errors
|
||
|
|
|
||
|
|
By default the validator stops processing after the first error. Set the `shortCircuit` parameter to `false` to emit all errors.
|
||
|
|
|
||
|
|
```js
|
||
|
|
const shortCircuit = false;
|
||
|
|
|
||
|
|
const draft = '2019-09';
|
||
|
|
|
||
|
|
const schema = {
|
||
|
|
type: 'object',
|
||
|
|
required: ['name', 'email', 'number', 'bool'],
|
||
|
|
properties: {
|
||
|
|
name: { type: 'string' },
|
||
|
|
email: { type: 'string', format: 'email' },
|
||
|
|
number: { type: 'number' },
|
||
|
|
bool: { type: 'boolean' }
|
||
|
|
}
|
||
|
|
};
|
||
|
|
|
||
|
|
const validator = new Validator(schema, draft, shortCircuit);
|
||
|
|
|
||
|
|
const result = validator.validate({
|
||
|
|
name: 'hello',
|
||
|
|
email: 5, // invalid type
|
||
|
|
number: 'Hello' // invalid type
|
||
|
|
bool: 'false' // invalid type
|
||
|
|
});
|
||
|
|
```
|