The validator mixin provides access to the features of the JSON validation system
members
_defaultSchemaName :string|function
The default name of the scheman when you use anonymous schemas. You can define this at the prototype for classified schemas. The can also
Type:
- string | function
schema :object
The schema that defines the validation rules. This should probably be defined at the prototype for each object or model classification. It can be an anonymous schema defined right here, or this can be registered schema names to use, or just a single name
Type:
- object
schemas :object
If you want to register multiple schemas, use this property instead
Type:
- object
validationOptions :object|function
The options to pass to the validator when it runs
Type:
- object | function
methods
addCheck(name, formatter)
It is possible to add support for custom checks (i.e., minItems, maxItems, minLength, maxLength, etc.) through the addCheck function
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
name |
string | The name of the check |
||||||
formatter |
function | Perform the check Properties
|
Returns:
- Type
- boolean
addFormat(name, formatter)
It is also possible to add support for additional string formats through the addFormat function.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
name |
string | The name of the formatter |
||||||
formatter |
function | How to format it Properties
|
Returns:
- Type
- boolean
addType(name, operation)
Create a type to be used in your schemas to define new validators
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
name |
string | The name of the type |
||||||
operation |
function | What to do with the type. Properties
|
Returns:
- Type
- boolean
addTypeCoercion(name, coercer)
Custom coercion rules
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
name |
string | The name of the coercion |
||||||
coercer |
function | Perform the coercion Properties
|
Returns:
- Type
- boolean
defaultDoc(schema)
Builds a default document based on the schema. What this does is create a document from schema and for each property that has a default value or is required, the resultant object will contain that property. It is useful for extending values from some source that may be incomplete, like options or some such.
Parameters:
| Name | Type | Description |
|---|---|---|
schema |
json-schema | A schema to use to create the default document |
Returns:
- Type
- object
extract( [record] [, schema])
Extracts only the elements of the object that are defined in the schema
Parameters:
| Name | Type | Argument | Description |
|---|---|---|---|
record |
object |
<optional> |
The record to extract from |
schema |
string |
<optional> |
The name of the schema to attach |
extract( [schema] [, src])
This method will create a new object that contains only the fields and no methods or other artifacts. This is useful for creating objects to pass over the wire or save in a table. This is not deeply copied, so changes made to the extracted object will be represented in this class for reference objects.
Parameters:
| Name | Type | Argument | Description |
|---|---|---|---|
schema |
string |
<optional> |
The schema name to use |
src |
object |
<optional> |
The object to extract fields from |
Returns:
Data-only version of the class instance.
- Type
- object
getSchema( [schemaName])
Get a registered schema by name
Parameters:
| Name | Type | Argument | Description |
|---|---|---|---|
schemaName |
string |
<optional> |
Returns:
- Type
- object
registerSchemas(schemas)
Initialize the schema collection by registering the with the handler. You can call this at any time and as often as you like. It will be called once by the constructor on any instance schemas
Parameters:
| Name | Type | Description |
|---|---|---|
schemas |
hash | A hash of schemas where the key is the name of the schema |
validate( [record], schemaName [, options])
Validate an object against the schema
Parameters:
| Name | Type | Argument | Description |
|---|---|---|---|
record |
object |
<optional> |
The record to validate |
schemaName |
string | object | The name of a previously registered schema |
|
options |
object |
<optional> |
Options to pass to the validator |
Returns:
- Type
- object
Example
// This supports these signatures: instance.validate(record, schemaName, options); instance.validate(); // this, this._defaultSchemaName, this.validationOptions instance.validate(record); // record, this._defaultSchemaName, this.validationOptions instance.validate(schemaName); //this, schemaName, this.validationOptions instance.validate(record, schemaName); //record, schemaName, this.validationOptions instance.validate(schemaName, options); //this, schemaName, this.validationOptions