https://github.com/scull7/bs-ajv
BuckleScript bindings to Ajv (Another JSON Validator)
https://github.com/scull7/bs-ajv
Last synced: 5 months ago
JSON representation
BuckleScript bindings to Ajv (Another JSON Validator)
- Host: GitHub
- URL: https://github.com/scull7/bs-ajv
- Owner: scull7
- License: mit
- Created: 2018-03-13T20:00:22.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2018-05-16T13:39:44.000Z (about 8 years ago)
- Last Synced: 2025-03-24T14:45:36.422Z (over 1 year ago)
- Language: OCaml
- Size: 123 KB
- Stars: 2
- Watchers: 1
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://www.travis-ci.org/scull7/bs-ajv)
[](https://coveralls.io/github/scull7/bs-ajv?branch=master)
# bs-ajv
BuckleScript bindings to [Ajv] (Another JSON Validator)
## Why?
To be able to use standardized validation schemas across our JavaScript and
BuckleScript based code.
## How do I install?
1. Add the [bs-ajv] package to your project via yarn/npm
```sh
yarn add bs-ajv
```
2. Add [bs-ajv] to your `bsconfig.json`
```json
{
"dependencies": [ "bs-ajv" ]
}
```
3. Enjoy!
## Usage
The interface here is a bit rough, but it is usable and is used within
production. Here are a few examples pulled from the [Ajv] docs.
### Basic first example
```reason
let schema = Json.Encode.(object_([
("properties", object_([
("smaller", object_([
("type", string("number")),
("maximum", object_([
("$data", string("1/larger")),
])),
])),
("larger", object_([
("type", string("number")),
])),
])),
]));
let validData = Json.Encode.(object_([
("smaller", int(5)),
("larger", int(7)),
]));
AjvOptions.make()
|> AjvOptions.setData(_, Js.true_)
|> Ajv.ajv
|> Ajv.validate(`Schema(schema), validData)
/* This will return `Js.true_` */
```
### Example with a self reference
```reason
let schema = Json.Encode.(object_([
("additionalProperties", object_([
("type", string("string")),
("format", object_([ ("$data", string("0#")) ]))
])),
]));
let validData = Json.Encode.(object_([
("date-time", string("1963-06-19T08:30:06.283185Z")),
("email", string("joe.bloggs@example.com")),
]));
AjvOptions.make()
|> AjvOptions.setData(_, Js.true_)
|> Ajv.ajv
|> Ajv.validate(`Schema(schema), validData)
/* This will return `Js.true_` */
```
### Example using schema compilation and additional property filtering
```reason
let schema = Json.Encode.(object_([
("additionalProperties", bool(false)),
("properties", object_([
("foo", object_([
("type", string("number")),
])),
("bar", object_([
("baz", object_([
("type", string("string")),
])),
])),
])),
]));
let validData = Json.Encode.(object_([
("foo", int(0)),
("additional1", int(1)),
("bar", object_([
("baz", string("abc")),
("additional2", int(2)),
])),
]));
AjvOptions.make()
|> AjvOptions.removeAdditional(_, Js.true_)
|> Ajv.ajv
|> Ajv.compile(schema)
|> (fun
| `Sync(fn) => fn
| `Async(_) => failwith("unexpected_async_mode")
)
|> (v) => validate(validData)
|> (fun
| `Valid(_) => Js.true_
| `Invalid(_) => Js.false_
)
/* This will return `Js.true_`
```
[Ajv]: http://epoberezkin.github.io/ajv/
[bs-ajv]: https://www.npmjs.com/package/bs-ajv