readme
parent
2de9b9e91e
commit
5dbdac619d
|
@ -63,11 +63,15 @@ ajv compiles schemas to functions and caches them in both cases (using stringifi
|
||||||
|
|
||||||
Create ajv instance.
|
Create ajv instance.
|
||||||
|
|
||||||
|
All the instance methods below are bound to the instance, so they can be used without the instance.
|
||||||
|
|
||||||
|
|
||||||
##### .compile(Object schema) -> Function<Object data>
|
##### .compile(Object schema) -> Function<Object data>
|
||||||
|
|
||||||
Generate validating function and cache the compiled schema for future use.
|
Generate validating function and cache the compiled schema for future use.
|
||||||
|
|
||||||
|
Validating function returns boolean and has properties `errors` with the errors from the last validation and `schema` with the reference to the original schema.
|
||||||
|
|
||||||
|
|
||||||
##### .validate(Object schema|String key|String ref, data) -> Boolean
|
##### .validate(Object schema|String key|String ref, data) -> Boolean
|
||||||
|
|
||||||
|
@ -76,7 +80,7 @@ Validate data using passed schema (it will be compiled and cached).
|
||||||
Instead of the schema you can use the key that was previously passed to `addSchema`, the schema id if it was present in the schema or any previously resolved reference.
|
Instead of the schema you can use the key that was previously passed to `addSchema`, the schema id if it was present in the schema or any previously resolved reference.
|
||||||
|
|
||||||
|
|
||||||
##### .addSchema(Array schemas|Object schema [, String key]) -> Function<Object data>|Array<Function<Object data>>
|
##### .addSchema(Array<Object>|Object schema [, String key]) -> Function|Array<Function>
|
||||||
|
|
||||||
Add and compile schema(s). It does the same as `.compile` with two differences:
|
Add and compile schema(s). It does the same as `.compile` with two differences:
|
||||||
|
|
||||||
|
@ -92,7 +96,7 @@ In the current version all the referenced schemas should be added before the sch
|
||||||
|
|
||||||
##### .getSchema(String key) -> Function<Object data>
|
##### .getSchema(String key) -> Function<Object data>
|
||||||
|
|
||||||
Retrieve schema previously added with `addSchema`. Validating function has `schema` property with the reference to the original schema.
|
Retrieve compiled schema previously added with `addSchema`. Validating function has `schema` property with the reference to the original schema.
|
||||||
|
|
||||||
|
|
||||||
## Options
|
## Options
|
||||||
|
|
Loading…
Reference in New Issue