Function
Path:
/src/type/function.coffeecompiled to/lib/type/function.js
The value has to be a function. Other values are not allowed.
Example:
CoffeeScript Code validator.check
name: 'test' # name to be displayed in errors (optional)
value: input # value to check
schema: # definition of checks
type: 'function'
, (err, result) ->
# do somethingSchema Specification
Function is a function schema definition.
An object with the following keys allowed: title, description, key, type, optional, default. The following entries have a specific format:
title-
Title is the title used to describe the element.
A text entry which is optional. All control characters will be removed.
description-
Description is the free description of the element.
A text entry which is optional. All control characters will be removed.
key-
Binding to Keyname is the mapping to which key names in an object this element belongs.
A valid regular expression which is optional. It has to be one of the following types:
- An object which has to be an instance of class
RegExp. - A text entry in which all control characters will be removed. The text should match: /^/.?/[gim]$/.
- An object which has to be an instance of class
type-
Type is the type of element.
A text entry in which all control characters will be removed.
optional-
Optional is a flag defining if this element is optional.
A boolean value, which will be true for ‘true’, ‘1’, ‘on’, ‘yes’, ‘+’, 1, true and will be considered as false for ‘false’, ‘0’, ‘off’, ‘no’, ‘-’, 0, false. It’s optional.
default-
Default Value is the default value to use if nothing given.
The value has to be a function/class which is optional.