Boolean

Path: /src/type/boolean.coffee compiled to /lib/type/boolean.js

The value has to be a boolean. The value will be true for 1, ‘true’, ‘on’, ‘yes’, ‘+’ and it will be considered as false for 0, ‘false’, ‘off’, ‘no’, ’-’, null and undefined. Other values are not allowed.

Format options:

format - (list) with the values for false and true

Example:

CoffeeScript Code
validator.check
  name: 'test'        # name to be displayed in errors (optional)
  value: input        # value to check
  schema:             # definition of checks
    type: 'boolean'
, (err, result) ->
  # do something

Schema Specification

Boolean is a boolean schema definition.

An object with the following keys allowed: format, title, description, key, type, optional, default. The following entries have a specific format:

format

Format is the display values for false and true.

A list which is optional. The number of entries have to be exactly 2 elements.

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]$/.

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.