vitalif-js
/
ajv
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

readme

master
Evgeny Poberezkin 2015-06-08 07:52:51 +01:00
parent 2de9b9e91e
commit 5dbdac619d
1 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -63,11 +63,15 @@ ajv compiles schemas to functions and caches them in both cases (using stringifi
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>
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
@ -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.
##### .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:
@ -92,7 +96,7 @@ In the current version all the referenced schemas should be added before the sch
##### .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