readme: custom keywords
Evgeny Poberezkin
parent
4fa6147710
commit
dfd2a7d71f
|
|
@ -0,0 +1,325 @@
|
|||
# Defining custom keywords
|
||||
|
||||
## Contents
|
||||
|
||||
- Define keyword with:
|
||||
- validation function (NOT RECOMMENDED)
|
||||
- compilation function
|
||||
- macro function
|
||||
- inline compilation function
|
||||
- Schema compilation context
|
||||
- Validation time variables
|
||||
- Ajv utilities
|
||||
- Reporting errors in custom keywords
|
||||
|
||||
|
||||
### Define keyword with validation function (NOT RECOMMENDED)
|
||||
|
||||
Validation function will be called during data validation. It will be passed schema, data and parentSchema (if it has 3 arguments) at validation time and it should return validation result as boolean. It can return an array of validation errors via `.errors` property of itself (otherwise a standard error will be used).
|
||||
|
||||
This way to define keywords is added as a way to quickly test your keyword and is not recommended because of worse performance than compiling schemas.
|
||||
|
||||
|
||||
Example. `constant` keyword from version 5 proposals (that is equivalent to `enum` keyword with one item):
|
||||
|
||||
```
|
||||
ajv.addKeyword('constant', { validate: function (schema, data) {
|
||||
return typeof schema == 'object && schema !== null'
|
||||
? deepEqual(schema, data)
|
||||
: schema === data;
|
||||
} });
|
||||
|
||||
var schema = { "constant": 2 };
|
||||
var validate = ajv.compile(schema);
|
||||
console.log(validate(2)); // true
|
||||
console.log(validate(3)); // false
|
||||
|
||||
var schema = { "constant": { "foo": "bar" } };
|
||||
var validate = ajv.compile(schema);
|
||||
console.log(validate({foo: 'bar'})); // true
|
||||
console.log(validate({foo: 'baz'})); // false
|
||||
```
|
||||
|
||||
`constant` keyword is already available in Ajv with option `v5: true`.
|
||||
|
||||
|
||||
### Define keyword with "compilation" function
|
||||
|
||||
Compilation function will be called during schema compilation. It will be passed schema and parent schema and it should return a validation function. This validation function will be passed data during validation; it should return validation result as boolean and it can return an array of validation errors via `.errors` property of itself (otherwise a standard error will be used).
|
||||
|
||||
In some cases it is the best approach to define keywords, but it has the performance cost of an extra function call during validation. If keyword logic can be expressed via some other JSON-schema then `macro` keyword definition is more efficient (see below).
|
||||
|
||||
Example. `range` and `exclusiveRange` keywords using compiled schema:
|
||||
|
||||
```
|
||||
ajv.addKeyword('range', { type: 'number', compile: function (sch, parentSchema) {
|
||||
var min = sch[0];
|
||||
var max = sch[1];
|
||||
|
||||
return parentSchema.exclusiveRange === true
|
||||
? function (data) { return data > min && data < max; }
|
||||
: function (data) { return data >= min && data <= max; }
|
||||
} });
|
||||
|
||||
var schema = { "range": [2, 4], "exclusiveRange": true };
|
||||
var validate = ajv.compile(schema);
|
||||
console.log(validate(2.01)); // true
|
||||
console.log(validate(3.99)); // true
|
||||
console.log(validate(2)); // false
|
||||
console.log(validate(4)); // false
|
||||
```
|
||||
|
||||
|
||||
### Define keyword with "macro" function
|
||||
|
||||
"Macro" function is called during schema compilation. It is passed schema and parent schema and it should return another schema that will be applied to the data in addition to the original schema.
|
||||
|
||||
It is the most efficient approach (in cases when the keyword logic can be expressed with another JSON-schema) because it is usually easy to implement and there is no extra function call during validation.
|
||||
|
||||
In addition to the errors from the expanded schema macro keyword will add its own error in case validation fails.
|
||||
|
||||
|
||||
Example. `range` and `exclusiveRange` keywords from the previous example defined with macro:
|
||||
|
||||
```
|
||||
ajv.addKeyword('range', { type: 'number', macro: function (schema, parentSchema) {
|
||||
return {
|
||||
minimum: schema[0],
|
||||
maximum: schema[1],
|
||||
exclusiveMinimum: !!parentSchema.exclusiveRange,
|
||||
exclusiveMaximum: !!parentSchema.exclusiveRange
|
||||
};
|
||||
} });
|
||||
```
|
||||
|
||||
Example. `contains` keyword from version 5 proposals that requires that the array has at least one item matching schema (see https://github.com/json-schema/json-schema/wiki/contains-(v5-proposal)):
|
||||
|
||||
```
|
||||
ajv.addKeyword('contains', { type: 'array', macro: function (schema) {
|
||||
return { "not": { "items": { "not": schema } } };
|
||||
} });
|
||||
|
||||
var schema = {
|
||||
"contains": {
|
||||
"type": "number",
|
||||
"minimum": 4,
|
||||
"exclusiveMinimum": true
|
||||
}
|
||||
};
|
||||
|
||||
var validate = ajv.compile(schema);
|
||||
console.log(validate([1,2,3])); // false
|
||||
console.log(validate([2,3,4])); // false
|
||||
console.log(validate([3,4,5])); // true, number 5 matches schema inside "contains"
|
||||
```
|
||||
|
||||
`contains` keyword is already available in Ajv with option `v5: true`.
|
||||
|
||||
See the example of defining recursive macro keyword `deepProperties` in the [test](https://github.com/epoberezkin/ajv/blob/master/spec/custom.spec.js#L151).
|
||||
|
||||
|
||||
### Define keyword with "inline" compilation function
|
||||
|
||||
Inline compilation function is called during schema compilation. It is passed four parameters: `it` (the current schema compilation context), `keyword` (added in v3.0 to simplify compiling multiple keywords with a single function), `schema` and `parentSchema` and it should return the code (as a string) that will be inlined in the code of compiled schema. This code can be either an expression that evaluates to the validation result (boolean) or a set of statements that assigns the validation result to a variable.
|
||||
|
||||
While it can be more challenging to define keywords with "inline" functions, it has several advantages:
|
||||
|
||||
- the best performance
|
||||
- the precise control over validation process
|
||||
- access to the parent data and the path to the currently validated data
|
||||
- access to ajv utilities via `it.util`
|
||||
|
||||
|
||||
Example `even` keyword:
|
||||
|
||||
```
|
||||
ajv.addKeyword('even', { type: 'number', inline: function (it, keyword, schema) {
|
||||
var op = schema ? '===' : '!==';
|
||||
return 'data' + (it.dataLevel || '') + ' % 2 ' + op + ' 0';
|
||||
} });
|
||||
|
||||
var schema = { "even": true };
|
||||
|
||||
var validate = ajv.compile(schema);
|
||||
console.log(validate(2)); // true
|
||||
console.log(validate(3)); // false
|
||||
```
|
||||
|
||||
`'data' + (it.dataLevel || '')` in the example above is the reference to the currently validated data. Also note that `schema` (keyword schema) is the same as `it.schema.even`, so schema is not strictly necessary here - it is passed for convenience.
|
||||
|
||||
|
||||
Example `range` keyword defined using [doT template](https://github.com/olado/doT):
|
||||
|
||||
```
|
||||
var doT = require('dot');
|
||||
var inlineRangeTemplate = doT.compile("\
|
||||
{{ \
|
||||
var $data = 'data' + (it.dataLevel || '') \
|
||||
, $min = it.schema.range[0] \
|
||||
, $max = it.schema.range[1] \
|
||||
, $gt = it.schema.exclusiveRange ? '>' : '>=' \
|
||||
, $lt = it.schema.exclusiveRange ? '<' : '<='; \
|
||||
}} \
|
||||
var valid{{=it.level}} = {{=$data}} {{=$gt}} {{=$min}} && {{=$data}} {{=$lt}} {{=$max}}; \
|
||||
");
|
||||
|
||||
ajv.addKeyword('range', {
|
||||
type: 'number',
|
||||
inline: inlineRangeTemplate,
|
||||
statements: true
|
||||
});
|
||||
```
|
||||
|
||||
`'valid' + it.level` in the example above is the expected name of the variable that should be set to the validation result.
|
||||
|
||||
Property `statements` in the keyword definition should be set to `true` if the validation code sets the variable instead of evaluating to the validation result.
|
||||
|
||||
The main challenge of defining inline keywords is that you have to write both the code that will execute during schema compilation (compile-time) and the code that will execute during data validation (validation-time - this code can be generated either using strings concatenation or using templates, see the examples below).
|
||||
|
||||
Ajv uses [doT templates](https://github.com/olado/doT) to generate the code of validation functions that makes it easier to separate compile-time and validation-time code because of the different syntax used. Ajv code also usually uses different variable names for compile-time and validation-time variables to make it easier to differentiate - compile-time variable names start from $ character.
|
||||
|
||||
Also you have to bear in mind that while compile-time variables exist in the scope of the function you wrote to compile the keyword so they are isolated, validation-time variables share the scope with all the variables in the scope of a single validation function. So if your keyword has subschemas you have to append the schema level (`it.level`) to the variable names.
|
||||
|
||||
See [schema compilation context](#schema-compilation-context) for more information on which properties and utilities from the schema compilation context you can use.
|
||||
|
||||
|
||||
## Schema compilation context
|
||||
|
||||
The first parameter passed to inline compilation keywords is `it`, the schema compilation context. All the properties and functions documented here are safe to use in your keywords, they won't be renamed or change their meaning without major version change.
|
||||
|
||||
`it` object has the following properties:
|
||||
|
||||
- _level_ - the level of the current schema, `0` on the top level, `1` in subschemas (e.g. schemas in `properties` or `anyOf` keyword). The value of this property should be appended to the validation-time variables you use in the generated code.
|
||||
- _dataLevel_ - the level of the currently validated data. It can be used to access both the property names and the data on all levels from the top. See [Validation time variables](#validation-time-variables).
|
||||
- _schema_ - current level schema. The value of your keyword is `it.schema[keyword]`. This value is also passed as the 3rd parameter to the inline compilation function and the current level schema as the 4th parameter.
|
||||
- _schemaPath_ - the validation time expression that evaluates to the property name of the current schema.
|
||||
- _opts_ - Ajv instance option. You should not be changing them.
|
||||
- _formats_ - all formats available in Ajv instance, including the custom ones.
|
||||
- _compositeRule_ - boolean indicating that the current schema is inside the compound keyword where failing some rule doesn't mean validation failure (`anyOf`, `oneOf`, `not`, `if` in `switch`).
|
||||
- _validate_ - the function you need to use to compile subschemas in your keywords (see the [implementation](https://github.com/epoberezkin/ajv/blob/master/lib/dot/v5/switch.jst) of `switch` keyword for example).
|
||||
- _util_ - [Ajv utilities](#ajv-utilities) you can use in your inline compilation functions.
|
||||
- _self_ - Ajv instance.
|
||||
|
||||
|
||||
## Validation time variables
|
||||
|
||||
There is a number of variables and expressions you can use in the generated (validation-time) code of your keywords.
|
||||
|
||||
- `'data' + (it.dataLevel || '')` - the variable name for the data at the current level.
|
||||
- `'data' + ((it.dataLevel-1)||'')` - parent data if `it.dataLevel > 0`.
|
||||
- `it.dataPathArr[it.dataLevel]` - the name of the property in the parent object that points to the current data if `it.dataLevel > 0`.
|
||||
- `'validate.schema'` - top level schema of the current validation function at validation-time.
|
||||
- `'validate.schema' + it.schemaPath` - current level schema available at validation time (the same schema at compile time is `it.schema`).
|
||||
- `'validate.schema' + it.schemaPath + '.' + keyword` - the value of your custom keyword at validation-time. Keyword is passed as the second parameter to the inline compilation function to allow using the same function to compile multiple keywords.
|
||||
- `'valid' + it.level` - the variable that you have to declare and to assign the validation result to if your keyword returns statements rather than expression (`statements: true`).
|
||||
|
||||
|
||||
## Ajv utilities
|
||||
|
||||
There are sevral useful functions you can use in your inline keywords. These functions are available as properties of `it.util` object:
|
||||
|
||||
##### .copy(Object obj[, Object target]) -> Object
|
||||
|
||||
Clone or extend the object. If one object is passed, it is cloned. If two objects are passed, the second object is extended with the properties of the first.
|
||||
|
||||
|
||||
##### .toHash(Array arr) -> Object
|
||||
|
||||
Converts the array of strings to the object where each string becomes the key with the value of `true`.
|
||||
|
||||
```
|
||||
it.util.toHash(['a', 'b', 'c']) // { a: true, b: true, c: true }
|
||||
```
|
||||
|
||||
|
||||
##### .getProperty(String key) -> String
|
||||
|
||||
Converts the string that is the key/index to access the property/item to the JavaScript syntax to access the property (either "." notation or "[...]" notation).
|
||||
|
||||
```
|
||||
it.util.toHash('a') // ".a"
|
||||
it.util.toHash('1') // "['1']"
|
||||
it.util.toHash("a'b") // "['a\\'b']"
|
||||
it.util.toHash(1) // "[1]"
|
||||
```
|
||||
|
||||
|
||||
##### .schemaHasRules(Object schema, Object rules) -> String
|
||||
|
||||
Determines whether the passed schema has rules that should be validated. This function should be used before calling `it.validate` to compile subschemas.
|
||||
|
||||
```
|
||||
it.util.schemaHasRules(schema, it.RULES.all) // true or false
|
||||
```
|
||||
|
||||
|
||||
##### .escapeQuotes(String str) -> String
|
||||
|
||||
Escapes single quotes in the string, so it can be inserted in the generated code inside the string constant with the single quotes.
|
||||
|
||||
|
||||
##### .toQuotedString(String str) -> String
|
||||
|
||||
Converts the string to the JavaScript string constant in single quotes (using the escaped string).
|
||||
|
||||
```
|
||||
it.util.toQuotedString("a'b") // "'a\\'b'"
|
||||
```
|
||||
|
||||
|
||||
##### .getData(String jsonPointer, Number dataLevel, Array paths) -> String
|
||||
|
||||
Returns the validation-time expression to safely access data based on the passed [relative json pointer](https://tools.ietf.org/html/draft-luff-relative-json-pointer-00) (See [examples](https://gist.github.com/geraintluff/5911303)).
|
||||
|
||||
```
|
||||
it.getData('2/test/1', it.dataLevel, it.dataPathArr)
|
||||
// The result depends on the current level
|
||||
// if it.dataLevel is 3 the result is "data1 && data1.test && data1.test[1]"
|
||||
```
|
||||
|
||||
|
||||
##### .escapeJsonPointer(String str) -> String
|
||||
|
||||
Converts the property name to the JSON-Pointer fragment.
|
||||
|
||||
|
||||
##### .unescapeJsonPointer (String str) -> String
|
||||
|
||||
Converts JSON-Pointer fragment to the property name.
|
||||
|
||||
|
||||
##### .unescapeFragment(String str) -> String
|
||||
|
||||
Converts the property name to the JSON-Pointer fragment that can be used in URI.
|
||||
|
||||
|
||||
##### .escapeFragment(String str) -> String
|
||||
|
||||
Converts the JSON-Pointer fragment from URI to the property name.
|
||||
|
||||
|
||||
## Reporting errors in custom keywords
|
||||
|
||||
All custom keywords but macro keywords can create custom error messages.
|
||||
|
||||
Validating and compiled keywords should define errors by assigning them to `.errors` property of the validation function.
|
||||
|
||||
Inline custom keyword should increase error counter `errors` and add error to `vErrors` array (it can be null). See [example range keyword](https://github.com/epoberezkin/ajv/blob/master/spec/custom_rules/range_with_errors.jst).
|
||||
|
||||
When inline keyword performs validation Ajv checks whether it created errors by comparing errors count before and after validation. To skip this check add option `errors` (can be `"full"`, `true` or `false`) to keyword definition:
|
||||
|
||||
```
|
||||
ajv.addKeyword('range', {
|
||||
type: 'number',
|
||||
inline: inlineRangeTemplate,
|
||||
statements: true,
|
||||
errors: true // keyword should create custom errors when validation fails
|
||||
// or errors: 'full' // created errors should have dataPath already set
|
||||
});
|
||||
```
|
||||
|
||||
Each error object should have properties `keyword`, `message` and `params`, other properties will be added.
|
||||
|
||||
Inlined keywords can optionally define `dataPath` property in error objects, that will be added by ajv unless `errors` option of the keyword is `"full"`.
|
||||
|
||||
If custom keyword doesn't create errors, the default error will be created in case the keyword fails validation (see [Validation errors](#validation-errors)).
|
||||
175
README.md
175
README.md
|
|
@ -196,12 +196,14 @@ var validData = {
|
|||
|
||||
Starting from version 2.0.0 ajv supports custom keyword definitions.
|
||||
|
||||
WARNING: The main drawback of extending JSON-schema standard with custom keywords is the loss of portability of your schemas - it may not be possible to support these custom keywords on some other platforms. Also your schemas may be more challenging to read for other people. If portability is important you may prefer using additional validation logic outside of JSON-schema rather than putting it inside your JSON-schema.
|
||||
|
||||
The advantages of using custom keywords are:
|
||||
- they allow you keeping a larger portion of your validation logic in the schema
|
||||
- they make your schemas more expressive and less verbose
|
||||
- they are fun to use
|
||||
|
||||
- allow creating validation scenarios that cannot be expressed using JSON-Schema
|
||||
- simplify your schemas
|
||||
- help bringing a bigger part of the validation logic to your schemas
|
||||
- make your schemas more expressive, less verbose and closer to your application domain.
|
||||
|
||||
The concerns you have to be aware of when extending JSON-schema standard with custom keywords are the portability and understanding of your schemas. You will have to support these custom keywords on other platforms and to properly document these keywords so that everybody can understand them in your schemas.
|
||||
|
||||
You can define custom keywords with [addKeyword](#api-addkeyword) method. Keywords are defined on the `ajv` instance level - new instances will not have previously defined keywords.
|
||||
|
||||
|
|
@ -211,43 +213,6 @@ Ajv allows defining keywords with:
|
|||
- macro function
|
||||
- inline compilation function that should return code (as string) that will be inlined in the currently compiled schema.
|
||||
|
||||
|
||||
### Define keyword with validation function (NOT RECOMMENDED)
|
||||
|
||||
Validation function will be called during data validation. It will be passed schema, data and parentSchema (if it has 3 arguments) at validation time and it should return validation result as boolean. It can return an array of validation errors via `.errors` property of itself (otherwise a standard error will be used).
|
||||
|
||||
This way to define keywords is added as a way to quickly test your keyword and is not recommended because of worse performance than compiling schemas.
|
||||
|
||||
|
||||
Example. `constant` keyword from version 5 proposals (that is equivalent to `enum` keyword with one item):
|
||||
|
||||
```
|
||||
ajv.addKeyword('constant', { validate: function (schema, data) {
|
||||
return typeof schema == 'object && schema !== null'
|
||||
? deepEqual(schema, data)
|
||||
: schema === data;
|
||||
} });
|
||||
|
||||
var schema = { "constant": 2 };
|
||||
var validate = ajv.compile(schema);
|
||||
console.log(validate(2)); // true
|
||||
console.log(validate(3)); // false
|
||||
|
||||
var schema = { "constant": { "foo": "bar" } };
|
||||
var validate = ajv.compile(schema);
|
||||
console.log(validate({foo: 'bar'})); // true
|
||||
console.log(validate({foo: 'baz'})); // false
|
||||
```
|
||||
|
||||
`constant` keyword is already available in Ajv with option `v5: true`.
|
||||
|
||||
|
||||
### Define keyword with "compilation" function
|
||||
|
||||
Compilation function will be called during schema compilation. It will be passed schema and parent schema and it should return a validation function. This validation function will be passed data during validation; it should return validation result as boolean and it can return an array of validation errors via `.errors` property of itself (otherwise a standard error will be used).
|
||||
|
||||
In some cases it is the best approach to define keywords, but it has the performance cost of an extra function call during validation. If keyword logic can be expressed via some other JSON-schema then `macro` keyword definition is more efficient (see below).
|
||||
|
||||
Example. `range` and `exclusiveRange` keywords using compiled schema:
|
||||
|
||||
```
|
||||
|
|
@ -268,131 +233,7 @@ console.log(validate(2)); // false
|
|||
console.log(validate(4)); // false
|
||||
```
|
||||
|
||||
|
||||
### Define keyword with "macro" function
|
||||
|
||||
"Macro" function is called during schema compilation. It is passed schema and parent schema and it should return another schema that will be applied to the data in addition to the original schema.
|
||||
|
||||
It is the most efficient approach (in cases when the keyword logic can be expressed with another JSON-schema) because it is usually easy to implement and there is no extra function call during validation.
|
||||
|
||||
In addition to the errors from the expanded schema macro keyword will add its own error in case validation fails.
|
||||
|
||||
|
||||
Example. `range` and `exclusiveRange` keywords from the previous example defined with macro:
|
||||
|
||||
```
|
||||
ajv.addKeyword('range', { type: 'number', macro: function (schema, parentSchema) {
|
||||
return {
|
||||
minimum: schema[0],
|
||||
maximum: schema[1],
|
||||
exclusiveMinimum: !!parentSchema.exclusiveRange,
|
||||
exclusiveMaximum: !!parentSchema.exclusiveRange
|
||||
};
|
||||
} });
|
||||
```
|
||||
|
||||
Example. `contains` keyword from version 5 proposals that requires that the array has at least one item matching schema (see https://github.com/json-schema/json-schema/wiki/contains-(v5-proposal)):
|
||||
|
||||
```
|
||||
ajv.addKeyword('contains', { type: 'array', macro: function (schema) {
|
||||
return { "not": { "items": { "not": schema } } };
|
||||
} });
|
||||
|
||||
var schema = {
|
||||
"contains": {
|
||||
"type": "number",
|
||||
"minimum": 4,
|
||||
"exclusiveMinimum": true
|
||||
}
|
||||
};
|
||||
|
||||
var validate = ajv.compile(schema);
|
||||
console.log(validate([1,2,3])); // false
|
||||
console.log(validate([2,3,4])); // false
|
||||
console.log(validate([3,4,5])); // true, number 5 matches schema inside "contains"
|
||||
```
|
||||
|
||||
`contains` keyword is already available in Ajv with option `v5: true`.
|
||||
|
||||
See the example of defining recursive macro keyword `deepProperties` in the [test](https://github.com/epoberezkin/ajv/blob/master/spec/custom.spec.js#L151).
|
||||
|
||||
|
||||
### Define keyword with "inline" compilation function
|
||||
|
||||
Inline compilation function is called during schema compilation. It is passed four parameters: `it` (the current schema compilation context), `keyword` (added in v3.0 to simplify compiling multiple keywords with a single function), `schema` and `parentSchema` and it should return the code (as a string) that will be inlined in the code of compiled schema. This code can be either an expression that evaluates to the validation result (boolean) or a set of statements that assigns the validation result to a variable.
|
||||
|
||||
While it can be more difficult to define keywords with "inline" functions, it can have the best performance.
|
||||
|
||||
Example `even` keyword:
|
||||
|
||||
```
|
||||
ajv.addKeyword('even', { type: 'number', inline: function (it, keyword, schema) {
|
||||
var op = schema ? '===' : '!==';
|
||||
return 'data' + (it.dataLevel || '') + ' % 2 ' + op + ' 0';
|
||||
} });
|
||||
|
||||
var schema = { "even": true };
|
||||
|
||||
var validate = ajv.compile(schema);
|
||||
console.log(validate(2)); // true
|
||||
console.log(validate(3)); // false
|
||||
```
|
||||
|
||||
`'data' + (it.dataLevel || '')` in the example above is the reference to the currently validated data. Also note that `schema` (keyword schema) is the same as `it.schema.even`, so schema is not strictly necessary here - it is passed for convenience.
|
||||
|
||||
|
||||
Example `range` keyword defined using [doT template](https://github.com/olado/doT):
|
||||
|
||||
```
|
||||
var doT = require('dot');
|
||||
var inlineRangeTemplate = doT.compile("\
|
||||
{{ \
|
||||
var $data = 'data' + (it.dataLevel || '') \
|
||||
, $min = it.schema.range[0] \
|
||||
, $max = it.schema.range[1] \
|
||||
, $gt = it.schema.exclusiveRange ? '>' : '>=' \
|
||||
, $lt = it.schema.exclusiveRange ? '<' : '<='; \
|
||||
}} \
|
||||
var valid{{=it.level}} = {{=$data}} {{=$gt}} {{=$min}} && {{=$data}} {{=$lt}} {{=$max}}; \
|
||||
");
|
||||
|
||||
ajv.addKeyword('range', {
|
||||
type: 'number',
|
||||
inline: inlineRangeTemplate,
|
||||
statements: true
|
||||
});
|
||||
```
|
||||
|
||||
`'valid' + it.level` in the example above is the expected name of the variable that should be set to the validation result.
|
||||
|
||||
Property `statements` in the keyword definition should be set to `true` if the validation code sets the variable instead of evaluating to the validation result.
|
||||
|
||||
|
||||
### Defining errors in custom keywords
|
||||
|
||||
All custom keywords but macro keywords can create custom error messages.
|
||||
|
||||
Validating and compiled keywords should define errors by assigning them to `.errors` property of the validation function.
|
||||
|
||||
Inline custom keyword should increase error counter `errors` and add error to `vErrors` array (it can be null). See [example range keyword](https://github.com/epoberezkin/ajv/blob/master/spec/custom_rules/range_with_errors.jst).
|
||||
|
||||
When inline keyword performs validation Ajv checks whether it created errors by comparing errors count before and after validation. To skip this check add option `errors` (can be `"full"`, `true` or `false`) to keyword definition:
|
||||
|
||||
```
|
||||
ajv.addKeyword('range', {
|
||||
type: 'number',
|
||||
inline: inlineRangeTemplate,
|
||||
statements: true,
|
||||
errors: true // keyword should create custom errors when validation fails
|
||||
// or errors: 'full' // created errors should have dataPath already set
|
||||
});
|
||||
```
|
||||
|
||||
Each error object should have properties `keyword`, `message` and `params`, other properties will be added.
|
||||
|
||||
Inlined keywords can optionally define `dataPath` property in error objects, that will be added by ajv unless `errors` option of the keyword is `"full"`.
|
||||
|
||||
If custom keyword doesn't create errors, the default error will be created in case the keyword fails validation (see [Validation errors](#validation-errors)).
|
||||
See [Defining custom keywords](https://github.com/epoberezkin/ajv/blob/master/CUSTOM.md) for details.
|
||||
|
||||
|
||||
## Asynchronous compilation
|
||||
|
|
|
|||
Loading…
Reference in New Issue