## Classes
InstanceValidator

Validate values in a nested object using a dot notation structure (e.g. .shouldBeString("Person.Address.Street.zip")) System will validate the the Person, Person.Address, and Person.Address.Street objects exist, and will validate that zip is a String.

Use this interface if you want to utilize the following functionality:

  1. Nested object validation using a dot notation.
SingletonValidator

Validate single value with a chainable interface. Use this interface if you want to utilize the following functionality:

  1. Error message templating.
  2. Only templates error message if validation fails which saves event queue cycles.
  3. Chain together precondition validations.
ErrrDecorator

Error Builder allows you to use optional functions to build an error object. The error can have appended stack traces and debug params to assist with debugging.

ErrrValidator

Validate single value with a buildable interface on top of the errr node module. Use this interface if you want to utilize the following functionality:

  1. Error message templating.
  2. Only templates error message if ErrrValidator fails which saves event queue cycles.
  3. Gives ability to append Stack traces to an existing error.
  4. Gives ability to append debug params to stack trace.
Preconditions

Preconditions entry point interface.

## InstanceValidator Validate values in a nested object using a dot notation structure (e.g. .shouldBeString("Person.Address.Street.zip")) System will validate the the Person, Person.Address, and Person.Address.Street objects exist, and will validate that zip is a String. Use this interface if you want to utilize the following functionality: 1. Nested object validation using a dot notation. **Kind**: global class * [InstanceValidator](#InstanceValidator) * [new InstanceValidator(objectUnderTest)](#new_InstanceValidator_new) * [.shouldBeDefined(configPath, [message])](#InstanceValidator+shouldBeDefined) ⇒ this * [.shouldBeUndefined(configPath, [message])](#InstanceValidator+shouldBeUndefined) ⇒ this * [.shouldBeNonEmptyArray(configPath, [message])](#InstanceValidator+shouldBeNonEmptyArray) ⇒ this * [.shouldBeArray(configPath, [message])](#InstanceValidator+shouldBeArray) ⇒ this * [.shouldNotBeArray(configPath, [message])](#InstanceValidator+shouldNotBeArray) ⇒ this * [.shouldBeObject(configPath, [message])](#InstanceValidator+shouldBeObject) ⇒ this * [.shouldNotBeObject(configPath, [message])](#InstanceValidator+shouldNotBeObject) ⇒ this * [.shouldBeEmpty(configPath, [message])](#InstanceValidator+shouldBeEmpty) ⇒ this * [.shouldNotBeEmpty(configPath, [message])](#InstanceValidator+shouldNotBeEmpty) ⇒ this * [.shouldBeFunction(configPath, [message])](#InstanceValidator+shouldBeFunction) ⇒ this * [.shouldNotBeFunction(configPath, [message])](#InstanceValidator+shouldNotBeFunction) ⇒ this * [.shouldBeString(configPath, [message])](#InstanceValidator+shouldBeString) ⇒ this * [.shouldNotBeString(configPath, [message])](#InstanceValidator+shouldNotBeString) ⇒ this * [.shouldBeNumber(configPath, [message])](#InstanceValidator+shouldBeNumber) ⇒ this * [.shouldNotBeNumber(configPath, [message])](#InstanceValidator+shouldNotBeNumber) ⇒ this * [.shouldBeFinite(configPath, [message])](#InstanceValidator+shouldBeFinite) ⇒ this * [.shouldBeInfinite(configPath, [message])](#InstanceValidator+shouldBeInfinite) ⇒ this * [.shouldBeBoolean(configPath, [message])](#InstanceValidator+shouldBeBoolean) ⇒ this * [.shouldNotBeBoolean(configPath, [message])](#InstanceValidator+shouldNotBeBoolean) ⇒ this * [.shouldBeDate(configPath, [message])](#InstanceValidator+shouldBeDate) ⇒ this * [.shouldNotBeDate(configPath, [message])](#InstanceValidator+shouldNotBeDate) ⇒ this * [.shouldBeRegExp(configPath, [message])](#InstanceValidator+shouldBeRegExp) ⇒ this * [.shouldNotBeRegExp(configPath, [message])](#InstanceValidator+shouldNotBeRegExp) ⇒ this * [.shouldBeFalsey(configPath, [message])](#InstanceValidator+shouldBeFalsey) ⇒ this * [.shouldNotBeFalsey(configPath, [message])](#InstanceValidator+shouldNotBeFalsey) ⇒ this * [.shouldBeFalsy(configPath, [message])](#InstanceValidator+shouldBeFalsy) ⇒ this * [.shouldNotBeFalsy(configPath, [message])](#InstanceValidator+shouldNotBeFalsy) ⇒ this * [.shouldBeTruthy(configPath, [message])](#InstanceValidator+shouldBeTruthy) ⇒ this * [.shouldNotBeTruthy(configPath, [message])](#InstanceValidator+shouldNotBeTruthy) ⇒ this * [.checkArgument(expression, [message], [template])](#InstanceValidator+checkArgument) ⇒ this * [.checkState(expression, [message])](#InstanceValidator+checkState) ⇒ this * [.checkElementIndex(index, size, [message])](#InstanceValidator+checkElementIndex) ⇒ this * [.checkPositionIndex(index, size, [message])](#InstanceValidator+checkPositionIndex) ⇒ this * [.checkPositionIndexes(start, end, size, [message])](#InstanceValidator+checkPositionIndexes) ⇒ this ### new InstanceValidator(objectUnderTest) | Param | Type | Description | | --- | --- | --- | | objectUnderTest | Object | Object to run validations against. | ### instanceValidator.shouldBeDefined(configPath, [message]) ⇒ this Throws an error if any value does not exist in the objectToTest, from configPath. Throws an error if the last key from configPath is defined. **Kind**: instance method of [InstanceValidator](#InstanceValidator) **Returns**: this - - Returns itself to allow chainable validations. | Param | Type | Description | | --- | --- | --- | | configPath | String | The value to validate. | | [message] | String | The error message or the error template string to use if the validation fails. | ### instanceValidator.shouldBeUndefined(configPath, [message]) ⇒ this Throws an error if any value does not exist in the objectToTest, from configPath. Throws an error if the last key from configPath is not defined. **Kind**: instance method of [InstanceValidator](#InstanceValidator) **Returns**: this - - Returns itself to allow chainable validations. | Param | Type | Description | | --- | --- | --- | | configPath | String | The value to validate. | | [message] | String | The error message or the error template string to use if the validation fails. | ### instanceValidator.shouldBeNonEmptyArray(configPath, [message]) ⇒ this Throws an error if any value does not exist in the objectToTest, from configPath. Throws an error if the last key from configPath is not an array or is an empty array. **Kind**: instance method of [InstanceValidator](#InstanceValidator) **Returns**: this - - Returns itself to allow chainable validations. | Param | Type | Description | | --- | --- | --- | | configPath | String | The value to validate. | | [message] | String | The error message or the error template string to use if the validation fails. | ### instanceValidator.shouldBeArray(configPath, [message]) ⇒ this Throws an error if any value does not exist in the objectToTest, from configPath. Throws an error if the last key from configPath is an array. **Kind**: instance method of [InstanceValidator](#InstanceValidator) **Returns**: this - - Returns itself to allow chainable validations. | Param | Type | Description | | --- | --- | --- | | configPath | String | The value to validate. | | [message] | String | The error message or the error template string to use if the validation fails. | ### instanceValidator.shouldNotBeArray(configPath, [message]) ⇒ this Throws an error if any value does not exist in the objectToTest, from configPath. Throws an error if the last key from configPath is not an array. **Kind**: instance method of [InstanceValidator](#InstanceValidator) **Returns**: this - - Returns itself to allow chainable validations. | Param | Type | Description | | --- | --- | --- | | configPath | String | The value to validate. | | [message] | String | The error message or the error template string to use if the validation fails. | ### instanceValidator.shouldBeObject(configPath, [message]) ⇒ this Throws an error if any value does not exist in the objectToTest, from configPath. Throws an error if the last key from configPath is of type Object. **Kind**: instance method of [InstanceValidator](#InstanceValidator) **Returns**: this - - Returns itself to allow chainable validations. | Param | Type | Description | | --- | --- | --- | | configPath | String | The value to validate. | | [message] | String | The error message or the error template string to use if the validation fails. | ### instanceValidator.shouldNotBeObject(configPath, [message]) ⇒ this Throws an error if any value does not exist in the objectToTest, from configPath. Throws an error if the last key from configPath is not of type Object. **Kind**: instance method of [InstanceValidator](#InstanceValidator) **Returns**: this - - Returns itself to allow chainable validations. | Param | Type | Description | | --- | --- | --- | | configPath | String | The value to validate. | | [message] | String | The error message or the error template string to use if the validation fails. | ### instanceValidator.shouldBeEmpty(configPath, [message]) ⇒ this Throws an error if any value does not exist in the objectToTest, from configPath. Throws an error if the last key from configPath is not empty. **Kind**: instance method of [InstanceValidator](#InstanceValidator) **Returns**: this - - Returns itself to allow chainable validations. | Param | Type | Description | | --- | --- | --- | | configPath | String | The value to validate. | | [message] | String | The error message or the error template string to use if the validation fails. | ### instanceValidator.shouldNotBeEmpty(configPath, [message]) ⇒ this Throws an error if any value does not exist in the objectToTest, from configPath. Throws an error if the last key from configPath is empty. **Kind**: instance method of [InstanceValidator](#InstanceValidator) **Returns**: this - - Returns itself to allow chainable validations. | Param | Type | Description | | --- | --- | --- | | configPath | String | The value to validate. | | [message] | String | The error message or the error template string to use if the validation fails. | ### instanceValidator.shouldBeFunction(configPath, [message]) ⇒ this Throws an error if any value does not exist in the objectToTest, from configPath. Throws an error if the last key from configPath is not of type Function. **Kind**: instance method of [InstanceValidator](#InstanceValidator) **Returns**: this - - Returns itself to allow chainable validations. | Param | Type | Description | | --- | --- | --- | | configPath | String | The value to validate. | | [message] | String | The error message or the error template string to use if the validation fails. | ### instanceValidator.shouldNotBeFunction(configPath, [message]) ⇒ this Throws an error if any value does not exist in the objectToTest, from configPath. Throws an error if the last key from configPath is of type Function. **Kind**: instance method of [InstanceValidator](#InstanceValidator) **Returns**: this - - Returns itself to allow chainable validations. | Param | Type | Description | | --- | --- | --- | | configPath | String | The value to validate. | | [message] | String | The error message or the error template string to use if the validation fails. | ### instanceValidator.shouldBeString(configPath, [message]) ⇒ this Throws an error if any value does not exist in the objectToTest, from configPath. Throws an error if the last key from configPath is not of type String. **Kind**: instance method of [InstanceValidator](#InstanceValidator) **Returns**: this - - Returns itself to allow chainable validations. | Param | Type | Description | | --- | --- | --- | | configPath | String | The value to validate. | | [message] | String | The error message or the error template string to use if the validation fails. | ### instanceValidator.shouldNotBeString(configPath, [message]) ⇒ this Throws an error if any value does not exist in the objectToTest, from configPath. Throws an error if the last key from configPath is of type String. **Kind**: instance method of [InstanceValidator](#InstanceValidator) **Returns**: this - - Returns itself to allow chainable validations. | Param | Type | Description | | --- | --- | --- | | configPath | String | The value to validate. | | [message] | String | The error message or the error template string to use if the validation fails. | ### instanceValidator.shouldBeNumber(configPath, [message]) ⇒ this Throws an error if any value does not exist in the objectToTest, from configPath. Throws an error if the last key from configPath is not of type Number. **Kind**: instance method of [InstanceValidator](#InstanceValidator) **Returns**: this - - Returns itself to allow chainable validations. | Param | Type | Description | | --- | --- | --- | | configPath | String | The value to validate. | | [message] | String | The error message or the error template string to use if the validation fails. | ### instanceValidator.shouldNotBeNumber(configPath, [message]) ⇒ this Throws an error if any value does not exist in the objectToTest, from configPath. Throws an error if the last key from configPath is of type Number. **Kind**: instance method of [InstanceValidator](#InstanceValidator) **Returns**: this - - Returns itself to allow chainable validations. | Param | Type | Description | | --- | --- | --- | | configPath | String | The value to validate. | | [message] | String | The error message or the error template string to use if the validation fails. | ### instanceValidator.shouldBeFinite(configPath, [message]) ⇒ this Throws an error if any value does not exist in the objectToTest, from configPath. Throws an error if the last key from configPath is not finite. **Kind**: instance method of [InstanceValidator](#InstanceValidator) **Returns**: this - - Returns itself to allow chainable validations. | Param | Type | Description | | --- | --- | --- | | configPath | String | The value to validate. | | [message] | String | The error message or the error template string to use if the validation fails. | ### instanceValidator.shouldBeInfinite(configPath, [message]) ⇒ this Throws an error if any value does not exist in the objectToTest, from configPath. Throws an error if the last key from configPath is not infinte. **Kind**: instance method of [InstanceValidator](#InstanceValidator) **Returns**: this - - Returns itself to allow chainable validations. | Param | Type | Description | | --- | --- | --- | | configPath | String | The value to validate. | | [message] | String | The error message or the error template string to use if the validation fails. | ### instanceValidator.shouldBeBoolean(configPath, [message]) ⇒ this Throws an error if any value does not exist in the objectToTest, from configPath. Throws an error if the last key from configPath is not of type Boolean. **Kind**: instance method of [InstanceValidator](#InstanceValidator) **Returns**: this - - Returns itself to allow chainable validations. | Param | Type | Description | | --- | --- | --- | | configPath | String | The value to validate. | | [message] | String | The error message or the error template string to use if the validation fails. | ### instanceValidator.shouldNotBeBoolean(configPath, [message]) ⇒ this Throws an error if any value does not exist in the objectToTest, from configPath. Throws an error if the last key from configPath is of type Boolean. **Kind**: instance method of [InstanceValidator](#InstanceValidator) **Returns**: this - - Returns itself to allow chainable validations. | Param | Type | Description | | --- | --- | --- | | configPath | String | The value to validate. | | [message] | String | The error message or the error template string to use if the validation fails. | ### instanceValidator.shouldBeDate(configPath, [message]) ⇒ this Throws an error if any value does not exist in the objectToTest, from configPath. Throws an error if the last key from configPath is not of type Date. **Kind**: instance method of [InstanceValidator](#InstanceValidator) **Returns**: this - - Returns itself to allow chainable validations. | Param | Type | Description | | --- | --- | --- | | configPath | String | The value to validate. | | [message] | String | The error message or the error template string to use if the validation fails. | ### instanceValidator.shouldNotBeDate(configPath, [message]) ⇒ this Throws an error if any value does not exist in the objectToTest, from configPath. Throws an error if the last key from configPath is of type Date. **Kind**: instance method of [InstanceValidator](#InstanceValidator) **Returns**: this - - Returns itself to allow chainable validations. | Param | Type | Description | | --- | --- | --- | | configPath | String | The value to validate. | | [message] | String | The error message or the error template string to use if the validation fails. | ### instanceValidator.shouldBeRegExp(configPath, [message]) ⇒ this Throws an error if any value does not exist in the objectToTest, from configPath. Throws an error if the last key from configPath is not a Regular Expression. **Kind**: instance method of [InstanceValidator](#InstanceValidator) **Returns**: this - - Returns itself to allow chainable validations. | Param | Type | Description | | --- | --- | --- | | configPath | String | The value to validate. | | [message] | String | The error message or the error template string to use if the validation fails. | ### instanceValidator.shouldNotBeRegExp(configPath, [message]) ⇒ this Throws an error if any value does not exist in the objectToTest, from configPath. Throws an error if the last key from configPath is a Regular Expression. **Kind**: instance method of [InstanceValidator](#InstanceValidator) **Returns**: this - - Returns itself to allow chainable validations. | Param | Type | Description | | --- | --- | --- | | configPath | String | The value to validate. | | [message] | String | The error message or the error template string to use if the validation fails. | ### instanceValidator.shouldBeFalsey(configPath, [message]) ⇒ this Throws an error if any value does not exist in the objectToTest, from configPath. Throws an error if the last key from configPath is not falsey. **Kind**: instance method of [InstanceValidator](#InstanceValidator) **Returns**: this - - Returns itself to allow chainable validations. | Param | Type | Description | | --- | --- | --- | | configPath | String | The value to validate. | | [message] | String | The error message or the error template string to use if the validation fails. | ### instanceValidator.shouldNotBeFalsey(configPath, [message]) ⇒ this Throws an error if any value does not exist in the objectToTest, from configPath. Throws an error if the last key from configPath is falsey. **Kind**: instance method of [InstanceValidator](#InstanceValidator) **Returns**: this - - Returns itself to allow chainable validations. | Param | Type | Description | | --- | --- | --- | | configPath | String | The value to validate. | | [message] | String | The error message or the error template string to use if the validation fails. | ### instanceValidator.shouldBeFalsy(configPath, [message]) ⇒ this Synonym for shouldBeFalsey. **Kind**: instance method of [InstanceValidator](#InstanceValidator) **Returns**: this - - Returns itself to allow chainable validations. | Param | Type | Description | | --- | --- | --- | | configPath | String | The value to validate. | | [message] | String | The error message or the error template string to use if the validation fails. | ### instanceValidator.shouldNotBeFalsy(configPath, [message]) ⇒ this Synonym for shouldNotBeFalsey. **Kind**: instance method of [InstanceValidator](#InstanceValidator) **Returns**: this - - Returns itself to allow chainable validations. | Param | Type | Description | | --- | --- | --- | | configPath | String | The value to validate. | | [message] | String | The error message or the error template string to use if the validation fails. | ### instanceValidator.shouldBeTruthy(configPath, [message]) ⇒ this Synonym for shouldNotBeFalsey. **Kind**: instance method of [InstanceValidator](#InstanceValidator) **Returns**: this - - Returns itself to allow chainable validations. | Param | Type | Description | | --- | --- | --- | | configPath | String | The value to validate. | | [message] | String | The error message or the error template string to use if the validation fails. | ### instanceValidator.shouldNotBeTruthy(configPath, [message]) ⇒ this Synonym for shouldBeFalsey. **Kind**: instance method of [InstanceValidator](#InstanceValidator) **Returns**: this - - Returns itself to allow chainable validations. | Param | Type | Description | | --- | --- | --- | | configPath | String | The value to validate. | | [message] | String | The error message or the error template string to use if the validation fails. | ### instanceValidator.checkArgument(expression, [message], [template]) ⇒ this Ensures the truth of an expression involving one or more parameters to the calling method. **Kind**: instance method of [InstanceValidator](#InstanceValidator) **Returns**: this - - Returns itself to allow chainable validations. | Param | Type | Description | | --- | --- | --- | | expression | String | The value to validate. | | [message] | String | The error message or the error template string to use if the validation fails. | | [template] | Array | Template params. If provided, the error message will be generated using util.format(message, template). | ### instanceValidator.checkState(expression, [message]) ⇒ this Ensures the truth of an expression involving the state of the calling InstanceValidator, but not involving any parameters to the calling method. **Kind**: instance method of [InstanceValidator](#InstanceValidator) **Returns**: this - - Returns itself to allow chainable validations. | Param | Type | Description | | --- | --- | --- | | expression | String | The value to validate. | | [message] | String | The error message or the error template string to use if the validation fails. | ### instanceValidator.checkElementIndex(index, size, [message]) ⇒ this Ensures that index specifies a valid element in an array, list or string of size size. **Kind**: instance method of [InstanceValidator](#InstanceValidator) **Returns**: this - - Returns itself to allow chainable validations. | Param | Type | Description | | --- | --- | --- | | index | Number | | | size | Number | | | [message] | String | The error message or the error template string to use if the validation fails. | ### instanceValidator.checkPositionIndex(index, size, [message]) ⇒ this Ensures that index specifies a valid position in an array, list or string of size size. **Kind**: instance method of [InstanceValidator](#InstanceValidator) **Returns**: this - - Returns itself to allow chainable validations. | Param | Type | Description | | --- | --- | --- | | index | Number | | | size | Number | | | [message] | String | The error message or the error template string to use if the validation fails. | ### instanceValidator.checkPositionIndexes(start, end, size, [message]) ⇒ this Ensures that start and end specify a valid positions in an array, list or string of size size, and are in order. **Kind**: instance method of [InstanceValidator](#InstanceValidator) **Returns**: this - - Returns itself to allow chainable validations. | Param | Type | Description | | --- | --- | --- | | start | Number | | | end | Number | | | size | Number | | | [message] | String | The error message or the error template string to use if the validation fails. | ## SingletonValidator Validate single value with a chainable interface. Use this interface if you want to utilize the following functionality: 1. Error message templating. 2. Only templates error message if validation fails which saves event queue cycles. 3. Chain together precondition validations. **Kind**: global class * [SingletonValidator](#SingletonValidator) * [.shouldBeDefined(val, [message], [template])](#SingletonValidator.shouldBeDefined) ⇒ this * [.shouldBeUndefined(val, [message], [template])](#SingletonValidator.shouldBeUndefined) ⇒ this * [.shouldBeArray(val, [message], [template])](#SingletonValidator.shouldBeArray) ⇒ this * [.shouldNotBeArray(val, [message], [template])](#SingletonValidator.shouldNotBeArray) ⇒ this * [.shouldBeObject(val, [message], [template])](#SingletonValidator.shouldBeObject) ⇒ this * [.shouldNotBeObject(val, [message], [template])](#SingletonValidator.shouldNotBeObject) ⇒ this * [.shouldBeEmpty(val, [message], [template])](#SingletonValidator.shouldBeEmpty) ⇒ this * [.shouldNotBeEmpty(val, [message], [template])](#SingletonValidator.shouldNotBeEmpty) ⇒ this * [.shouldBeFunction(val, [message], [template])](#SingletonValidator.shouldBeFunction) ⇒ this * [.shouldNotBeFunction(val, [message], [template])](#SingletonValidator.shouldNotBeFunction) ⇒ this * [.shouldBeString(val, [message], [template])](#SingletonValidator.shouldBeString) ⇒ this * [.shouldNotBeString(val, [message], [template])](#SingletonValidator.shouldNotBeString) ⇒ this * [.shouldBeNumber(val, [message], [template])](#SingletonValidator.shouldBeNumber) ⇒ this * [.shouldNotBeNumber(val, [message], [template])](#SingletonValidator.shouldNotBeNumber) ⇒ this * [.shouldBeFinite(val, [message], [template])](#SingletonValidator.shouldBeFinite) ⇒ this * [.shouldBeInfinite(val, [message], [template])](#SingletonValidator.shouldBeInfinite) ⇒ this * [.shouldBeBoolean(val, [message], [template])](#SingletonValidator.shouldBeBoolean) ⇒ this * [.shouldNotBeBoolean(val, [message], [template])](#SingletonValidator.shouldNotBeBoolean) ⇒ this * [.shouldBeDate(val, [message], [template])](#SingletonValidator.shouldBeDate) ⇒ this * [.shouldNotBeDate(val, [message], [template])](#SingletonValidator.shouldNotBeDate) ⇒ this * [.shouldBeRegExp(val, [message], [template])](#SingletonValidator.shouldBeRegExp) ⇒ this * [.shouldNotBeRegExp(val, [message], [template])](#SingletonValidator.shouldNotBeRegExp) ⇒ this * [.shouldBeFalsey(val, [message], [template])](#SingletonValidator.shouldBeFalsey) ⇒ this * [.shouldNotBeFalsey(val, [message], [template])](#SingletonValidator.shouldNotBeFalsey) ⇒ this * [.shouldBeFalsy(val, [message], [template])](#SingletonValidator.shouldBeFalsy) ⇒ this * [.shouldNotBeFalsy(val, [message], [template])](#SingletonValidator.shouldNotBeFalsy) ⇒ this * [.shouldBeTruthy(val, [message], [template])](#SingletonValidator.shouldBeTruthy) ⇒ this * [.shouldNotBeTruthy(val, [message], [template])](#SingletonValidator.shouldNotBeTruthy) ⇒ this * [.checkArgument(expression, [message], [template])](#SingletonValidator.checkArgument) ⇒ this * [.checkState(expression, [message], [template])](#SingletonValidator.checkState) ⇒ this * [.checkElementIndex(index, size, [message], [template])](#SingletonValidator.checkElementIndex) ⇒ this * [.checkPositionIndex(index, size, [message], [template])](#SingletonValidator.checkPositionIndex) ⇒ this * [.checkPositionIndexes(start, end, size, [message], [template])](#SingletonValidator.checkPositionIndexes) ⇒ this ### SingletonValidator.shouldBeDefined(val, [message], [template]) ⇒ this Throws an error if 'val' is not defined. **Kind**: static method of [SingletonValidator](#SingletonValidator) **Returns**: this - - Returns itself to allow chainable validations. | Param | Type | Description | | --- | --- | --- | | val | String | The value to validate. | | [message] | String | The error message or the error template string to use if the validation fails. | | [template] | Array | Template params. If provided, the error message will be generated using util.format(message, template). | ### SingletonValidator.shouldBeUndefined(val, [message], [template]) ⇒ this Throws an error if 'val' is defined. **Kind**: static method of [SingletonValidator](#SingletonValidator) **Returns**: this - - Returns itself to allow chainable validations. | Param | Type | Description | | --- | --- | --- | | val | String | The value to validate. | | [message] | String | The error message or the error template string to use if the validation fails. | | [template] | Array | Template params. If provided, the error message will be generated using util.format(message, template). | ### SingletonValidator.shouldBeArray(val, [message], [template]) ⇒ this Throws an error if 'val' is not of type Array. **Kind**: static method of [SingletonValidator](#SingletonValidator) **Returns**: this - - Returns itself to allow chainable validations. | Param | Type | Description | | --- | --- | --- | | val | String | The value to validate. | | [message] | String | The error message or the error template string to use if the validation fails. | | [template] | Array | Template params. If provided, the error message will be generated using util.format(message, template). | ### SingletonValidator.shouldNotBeArray(val, [message], [template]) ⇒ this Throws an error if 'val' is of type Array. **Kind**: static method of [SingletonValidator](#SingletonValidator) **Returns**: this - - Returns itself to allow chainable validations. | Param | Type | Description | | --- | --- | --- | | val | String | The value to validate. | | [message] | String | The error message or the error template string to use if the validation fails. | | [template] | Array | Template params. If provided, the error message will be generated using util.format(message, template). | ### SingletonValidator.shouldBeObject(val, [message], [template]) ⇒ this Throws an error if 'val' is not of type Object. **Kind**: static method of [SingletonValidator](#SingletonValidator) **Returns**: this - - Returns itself to allow chainable validations. | Param | Type | Description | | --- | --- | --- | | val | String | The value to validate. | | [message] | String | The error message or the error template string to use if the validation fails. | | [template] | Array | Template params. If provided, the error message will be generated using util.format(message, template). | ### SingletonValidator.shouldNotBeObject(val, [message], [template]) ⇒ this Throws an error if 'val' is of type Object. **Kind**: static method of [SingletonValidator](#SingletonValidator) **Returns**: this - - Returns itself to allow chainable validations. | Param | Type | Description | | --- | --- | --- | | val | String | The value to validate. | | [message] | String | The error message or the error template string to use if the validation fails. | | [template] | Array | Template params. If provided, the error message will be generated using util.format(message, template). | ### SingletonValidator.shouldBeEmpty(val, [message], [template]) ⇒ this Throws an error if 'val' is not empty. **Kind**: static method of [SingletonValidator](#SingletonValidator) **Returns**: this - - Returns itself to allow chainable validations. | Param | Type | Description | | --- | --- | --- | | val | String | The value to validate. | | [message] | String | The error message or the error template string to use if the validation fails. | | [template] | Array | Template params. If provided, the error message will be generated using util.format(message, template). | ### SingletonValidator.shouldNotBeEmpty(val, [message], [template]) ⇒ this Throws an error if 'val' is empty. **Kind**: static method of [SingletonValidator](#SingletonValidator) **Returns**: this - - Returns itself to allow chainable validations. | Param | Type | Description | | --- | --- | --- | | val | String | The value to validate. | | [message] | String | The error message or the error template string to use if the validation fails. | | [template] | Array | Template params. If provided, the error message will be generated using util.format(message, template). | ### SingletonValidator.shouldBeFunction(val, [message], [template]) ⇒ this Throws an error if 'val' is not of type Function. **Kind**: static method of [SingletonValidator](#SingletonValidator) **Returns**: this - - Returns itself to allow chainable validations. | Param | Type | Description | | --- | --- | --- | | val | String | The value to validate. | | [message] | String | The error message or the error template string to use if the validation fails. | | [template] | Array | Template params. If provided, the error message will be generated using util.format(message, template). | ### SingletonValidator.shouldNotBeFunction(val, [message], [template]) ⇒ this Throws an error if 'val' is of type Function. **Kind**: static method of [SingletonValidator](#SingletonValidator) **Returns**: this - - Returns itself to allow chainable validations. | Param | Type | Description | | --- | --- | --- | | val | String | The value to validate. | | [message] | String | The error message or the error template string to use if the validation fails. | | [template] | Array | Template params. If provided, the error message will be generated using util.format(message, template). | ### SingletonValidator.shouldBeString(val, [message], [template]) ⇒ this Throws an error if 'val' is not of type String. **Kind**: static method of [SingletonValidator](#SingletonValidator) **Returns**: this - - Returns itself to allow chainable validations. | Param | Type | Description | | --- | --- | --- | | val | String | The value to validate. | | [message] | String | The error message or the error template string to use if the validation fails. | | [template] | Array | Template params. If provided, the error message will be generated using util.format(message, template). | ### SingletonValidator.shouldNotBeString(val, [message], [template]) ⇒ this Throws an error if 'val' is of type String. **Kind**: static method of [SingletonValidator](#SingletonValidator) **Returns**: this - - Returns itself to allow chainable validations. | Param | Type | Description | | --- | --- | --- | | val | String | The value to validate. | | [message] | String | The error message or the error template string to use if the validation fails. | | [template] | Array | Template params. If provided, the error message will be generated using util.format(message, template). | ### SingletonValidator.shouldBeNumber(val, [message], [template]) ⇒ this Throws an error if 'val' is not of type Number. **Kind**: static method of [SingletonValidator](#SingletonValidator) **Returns**: this - - Returns itself to allow chainable validations. | Param | Type | Description | | --- | --- | --- | | val | String | The value to validate. | | [message] | String | The error message or the error template string to use if the validation fails. | | [template] | Array | Template params. If provided, the error message will be generated using util.format(message, template). | ### SingletonValidator.shouldNotBeNumber(val, [message], [template]) ⇒ this Throws an error if 'val' is of type Number. **Kind**: static method of [SingletonValidator](#SingletonValidator) **Returns**: this - - Returns itself to allow chainable validations. | Param | Type | Description | | --- | --- | --- | | val | String | The value to validate. | | [message] | String | The error message or the error template string to use if the validation fails. | | [template] | Array | Template params. If provided, the error message will be generated using util.format(message, template). | ### SingletonValidator.shouldBeFinite(val, [message], [template]) ⇒ this Throws an error if 'val' is not finite. **Kind**: static method of [SingletonValidator](#SingletonValidator) **Returns**: this - - Returns itself to allow chainable validations. | Param | Type | Description | | --- | --- | --- | | val | String | The value to validate. | | [message] | String | The error message or the error template string to use if the validation fails. | | [template] | Array | Template params. If provided, the error message will be generated using util.format(message, template). | ### SingletonValidator.shouldBeInfinite(val, [message], [template]) ⇒ this Throws an error if 'val' is not infinite. **Kind**: static method of [SingletonValidator](#SingletonValidator) **Returns**: this - - Returns itself to allow chainable validations. | Param | Type | Description | | --- | --- | --- | | val | String | The value to validate. | | [message] | String | The error message or the error template string to use if the validation fails. | | [template] | Array | Template params. If provided, the error message will be generated using util.format(message, template). | ### SingletonValidator.shouldBeBoolean(val, [message], [template]) ⇒ this Throws an error if 'val' is not of type Boolean. **Kind**: static method of [SingletonValidator](#SingletonValidator) **Returns**: this - - Returns itself to allow chainable validations. | Param | Type | Description | | --- | --- | --- | | val | String | The value to validate. | | [message] | String | The error message or the error template string to use if the validation fails. | | [template] | Array | Template params. If provided, the error message will be generated using util.format(message, template). | ### SingletonValidator.shouldNotBeBoolean(val, [message], [template]) ⇒ this Throws an error if 'val' is of type Boolean. **Kind**: static method of [SingletonValidator](#SingletonValidator) **Returns**: this - - Returns itself to allow chainable validations. | Param | Type | Description | | --- | --- | --- | | val | String | The value to validate. | | [message] | String | The error message or the error template string to use if the validation fails. | | [template] | Array | Template params. If provided, the error message will be generated using util.format(message, template). | ### SingletonValidator.shouldBeDate(val, [message], [template]) ⇒ this Throws an error if 'val' is not of type Date. **Kind**: static method of [SingletonValidator](#SingletonValidator) **Returns**: this - - Returns itself to allow chainable validations. | Param | Type | Description | | --- | --- | --- | | val | String | The value to validate. | | [message] | String | The error message or the error template string to use if the validation fails. | | [template] | Array | Template params. If provided, the error message will be generated using util.format(message, template). | ### SingletonValidator.shouldNotBeDate(val, [message], [template]) ⇒ this Throws an error if 'val' is of type Date. **Kind**: static method of [SingletonValidator](#SingletonValidator) **Returns**: this - - Returns itself to allow chainable validations. | Param | Type | Description | | --- | --- | --- | | val | String | The value to validate. | | [message] | String | The error message or the error template string to use if the validation fails. | | [template] | Array | Template params. If provided, the error message will be generated using util.format(message, template). | ### SingletonValidator.shouldBeRegExp(val, [message], [template]) ⇒ this Throws an error if 'val' is not a Regular Expression. **Kind**: static method of [SingletonValidator](#SingletonValidator) **Returns**: this - - Returns itself to allow chainable validations. | Param | Type | Description | | --- | --- | --- | | val | String | The value to validate. | | [message] | String | The error message or the error template string to use if the validation fails. | | [template] | Array | Template params. If provided, the error message will be generated using util.format(message, template). | ### SingletonValidator.shouldNotBeRegExp(val, [message], [template]) ⇒ this Throws an error if 'val' is a Regular Expression. **Kind**: static method of [SingletonValidator](#SingletonValidator) **Returns**: this - - Returns itself to allow chainable validations. | Param | Type | Description | | --- | --- | --- | | val | String | The value to validate. | | [message] | String | The error message or the error template string to use if the validation fails. | | [template] | Array | Template params. If provided, the error message will be generated using util.format(message, template). | ### SingletonValidator.shouldBeFalsey(val, [message], [template]) ⇒ this Throws an error if 'val' is not falsey. **Kind**: static method of [SingletonValidator](#SingletonValidator) **Returns**: this - - Returns itself to allow chainable validations. | Param | Type | Description | | --- | --- | --- | | val | String | The value to validate. | | [message] | String | The error message or the error template string to use if the validation fails. | | [template] | Array | Template params. If provided, the error message will be generated using util.format(message, template). | ### SingletonValidator.shouldNotBeFalsey(val, [message], [template]) ⇒ this Throws an error if 'val' is falsey. **Kind**: static method of [SingletonValidator](#SingletonValidator) **Returns**: this - - Returns itself to allow chainable validations. | Param | Type | Description | | --- | --- | --- | | val | String | The value to validate. | | [message] | String | The error message or the error template string to use if the validation fails. | | [template] | Array | Template params. If provided, the error message will be generated using util.format(message, template). | ### SingletonValidator.shouldBeFalsy(val, [message], [template]) ⇒ this Synonym for shouldBeFalsey. **Kind**: static method of [SingletonValidator](#SingletonValidator) **Returns**: this - - Returns itself to allow chainable validations. | Param | Type | Description | | --- | --- | --- | | val | String | The value to validate. | | [message] | String | The error message or the error template string to use if the validation fails. | | [template] | Array | Template params. If provided, the error message will be generated using util.format(message, template). | ### SingletonValidator.shouldNotBeFalsy(val, [message], [template]) ⇒ this Synonym for shouldNotBeFalsey. **Kind**: static method of [SingletonValidator](#SingletonValidator) **Returns**: this - - Returns itself to allow chainable validations. | Param | Type | Description | | --- | --- | --- | | val | String | The value to validate. | | [message] | String | The error message or the error template string to use if the validation fails. | | [template] | Array | Template params. If provided, the error message will be generated using util.format(message, template). | ### SingletonValidator.shouldBeTruthy(val, [message], [template]) ⇒ this Synonym for shouldNotBeFalsey. **Kind**: static method of [SingletonValidator](#SingletonValidator) **Returns**: this - - Returns itself to allow chainable validations. | Param | Type | Description | | --- | --- | --- | | val | String | The value to validate. | | [message] | String | The error message or the error template string to use if the validation fails. | | [template] | Array | Template params. If provided, the error message will be generated using util.format(message, template). | ### SingletonValidator.shouldNotBeTruthy(val, [message], [template]) ⇒ this Synonym for shouldBeFalsey. **Kind**: static method of [SingletonValidator](#SingletonValidator) **Returns**: this - - Returns itself to allow chainable validations. | Param | Type | Description | | --- | --- | --- | | val | String | The value to validate. | | [message] | String | The error message or the error template string to use if the validation fails. | | [template] | Array | Template params. If provided, the error message will be generated using util.format(message, template). | ### SingletonValidator.checkArgument(expression, [message], [template]) ⇒ this Ensures the truth of an expression involving one or more parameters to the calling method. **Kind**: static method of [SingletonValidator](#SingletonValidator) **Returns**: this - - Returns itself to allow chainable validations. | Param | Type | Description | | --- | --- | --- | | expression | String | The value to validate. | | [message] | String | The error message or the error template string to use if the validation fails. | | [template] | Array | Template params. If provided, the error message will be generated using util.format(message, template). | ### SingletonValidator.checkState(expression, [message], [template]) ⇒ this Ensures the truth of an expression involving the state of the calling instance, but not involving any parameters to the calling method. **Kind**: static method of [SingletonValidator](#SingletonValidator) **Returns**: this - - Returns itself to allow chainable validations. | Param | Type | Description | | --- | --- | --- | | expression | String | The value to validate. | | [message] | String | The error message or the error template string to use if the validation fails. | | [template] | Array | Template params. If provided, the error message will be generated using util.format(message, template). | ### SingletonValidator.checkElementIndex(index, size, [message], [template]) ⇒ this Ensures that index specifies a valid element in an array, list or string of size size. **Kind**: static method of [SingletonValidator](#SingletonValidator) **Returns**: this - - Returns itself to allow chainable validations. | Param | Type | Description | | --- | --- | --- | | index | Number | | | size | Number | | | [message] | String | The error message or the error template string to use if the validation fails. | | [template] | Array | Template params. If provided, the error message will be generated using util.format(message, template). | ### SingletonValidator.checkPositionIndex(index, size, [message], [template]) ⇒ this Ensures that index specifies a valid position in an array, list or string of size size. **Kind**: static method of [SingletonValidator](#SingletonValidator) **Returns**: this - - Returns itself to allow chainable validations. | Param | Type | Description | | --- | --- | --- | | index | Number | | | size | Number | | | [message] | String | The error message or the error template string to use if the validation fails. | | [template] | Array | Template params. If provided, the error message will be generated using util.format(message, template). | ### SingletonValidator.checkPositionIndexes(start, end, size, [message], [template]) ⇒ this Ensures that start and end specify a valid positions in an array, list or string of size size, and are in order. **Kind**: static method of [SingletonValidator](#SingletonValidator) **Returns**: this - - Returns itself to allow chainable validations. | Param | Type | Description | | --- | --- | --- | | start | Number | | | end | Number | | | size | Number | | | [message] | String | The error message or the error template string to use if the validation fails. | | [template] | Array | Template params. If provided, the error message will be generated using util.format(message, template). | ## ErrrDecorator Error Builder allows you to use optional functions to build an error object. The error can have appended stack traces and debug params to assist with debugging. **Kind**: global class * [ErrrDecorator](#ErrrDecorator) * [new ErrrDecorator([message], [template])](#new_ErrrDecorator_new) * [.debug(params, [shouldDebug])](#ErrrDecorator+debug) ⇒ [ErrrDecorator](#ErrrDecorator) * [.set(key, value, [force])](#ErrrDecorator+set) ⇒ [ErrrDecorator](#ErrrDecorator) * [.setAll(key, value, [force])](#ErrrDecorator+setAll) ⇒ [ErrrDecorator](#ErrrDecorator) * [.appendTo(err)](#ErrrDecorator+appendTo) ⇒ [ErrrDecorator](#ErrrDecorator) * [.test()](#ErrrDecorator+test) * [.t()](#ErrrDecorator+t) ### new ErrrDecorator([message], [template]) Provides an interface to build an error. Then allows you to get or throw the error. | Param | Type | Description | | --- | --- | --- | | [message] | String | Error message that will supplied to Error Object. | | [template] | Array | Array of parameters. If given, util.format(message, template) will be applied to the message string. | ### errrDecorator.debug(params, [shouldDebug]) ⇒ [ErrrDecorator](#ErrrDecorator) Decorated function from 'errr' module. Add parameters to the stack trace that will make it easier to debug the problem. **Kind**: instance method of [ErrrDecorator](#ErrrDecorator) **Returns**: [ErrrDecorator](#ErrrDecorator) - - Returns the instance of errorBuilder to allow chainability. | Param | Type | Description | | --- | --- | --- | | params | Object | Object Map of key value parameters that will make it easier to debug the error. | | [shouldDebug] | Boolean | If shouldDebug === false, then debug params will not print. Any other value (including undefined), and the debug params will be printed. Useful if you want to only print debugParams given an Environment Variable. | ### errrDecorator.set(key, value, [force]) ⇒ [ErrrDecorator](#ErrrDecorator) Decorated function from 'errr' module. Sets an immutable value on the error object using the key as the variable name. **Kind**: instance method of [ErrrDecorator](#ErrrDecorator) **Returns**: [ErrrDecorator](#ErrrDecorator) - - Returns the instance of errorBuilder to allow chainability. | Param | Type | Description | | --- | --- | --- | | key | String | The key that will be used to set the value on the error object. | | value | Object | The value that will be set on the object. | | [force] | Boolean | If force equals true, then this value will override a value with the same key from an errr passed in using the 'appendTo' function. | ### errrDecorator.setAll(key, value, [force]) ⇒ [ErrrDecorator](#ErrrDecorator) Decorated function from 'errr' module. Same concept and functionality as the 'set' function. The difference is that you can set all values in a given object onto the Errr instance. **Kind**: instance method of [ErrrDecorator](#ErrrDecorator) **Returns**: [ErrrDecorator](#ErrrDecorator) - - Returns the instance of errorBuilder to allow chainability. | Param | Type | Description | | --- | --- | --- | | key | String | The key that will be used to set the value on the error object. | | value | Object | The value that will be set on the object. | | [force] | Boolean | If force equals true, then this value will override a value with the same key from an errr passed in using the 'appendTo' function. | ### errrDecorator.appendTo(err) ⇒ [ErrrDecorator](#ErrrDecorator) Decorated function from 'errr' module. Append the error being built, to the end of this error's stack trace. **Kind**: instance method of [ErrrDecorator](#ErrrDecorator) **Returns**: [ErrrDecorator](#ErrrDecorator) - - Returns the instance of errorBuilder to allow chainability. | Param | Type | Description | | --- | --- | --- | | err | Error | The stack trace of the error being built, will be appended to this error's stack trace. | ### errrDecorator.test() Validate preconditions check and throw an errr if it fails. **Kind**: instance method of [ErrrDecorator](#ErrrDecorator) ### errrDecorator.t() Synonym for the test function. **Kind**: instance method of [ErrrDecorator](#ErrrDecorator) ## ErrrValidator Validate single value with a buildable interface on top of the errr node module. Use this interface if you want to utilize the following functionality: 1. Error message templating. 2. Only templates error message if ErrrValidator fails which saves event queue cycles. 3. Gives ability to append Stack traces to an existing error. 4. Gives ability to append debug params to stack trace. **Kind**: global class * [ErrrValidator](#ErrrValidator) * [.shouldBeDefined(val, [message], [template])](#ErrrValidator.shouldBeDefined) ⇒ [ErrrDecorator](#ErrrDecorator) * [.shouldBeUndefined(val, [message], [template])](#ErrrValidator.shouldBeUndefined) ⇒ [ErrrDecorator](#ErrrDecorator) * [.shouldBeArray(val, [message], [template])](#ErrrValidator.shouldBeArray) ⇒ [ErrrDecorator](#ErrrDecorator) * [.shouldNotBeArray(val, [message], [template])](#ErrrValidator.shouldNotBeArray) ⇒ [ErrrDecorator](#ErrrDecorator) * [.shouldBeObject(val, [message], [template])](#ErrrValidator.shouldBeObject) ⇒ [ErrrDecorator](#ErrrDecorator) * [.shouldNotBeObject(val, [message], [template])](#ErrrValidator.shouldNotBeObject) ⇒ [ErrrDecorator](#ErrrDecorator) * [.shouldBeEmpty(val, [message], [template])](#ErrrValidator.shouldBeEmpty) ⇒ [ErrrDecorator](#ErrrDecorator) * [.shouldNotBeEmpty(val, [message], [template])](#ErrrValidator.shouldNotBeEmpty) ⇒ [ErrrDecorator](#ErrrDecorator) * [.shouldBeFunction(val, [message], [template])](#ErrrValidator.shouldBeFunction) ⇒ [ErrrDecorator](#ErrrDecorator) * [.shouldNotBeFunction(val, [message], [template])](#ErrrValidator.shouldNotBeFunction) ⇒ [ErrrDecorator](#ErrrDecorator) * [.shouldBeString(val, [message], [template])](#ErrrValidator.shouldBeString) ⇒ [ErrrDecorator](#ErrrDecorator) * [.shouldNotBeString(val, [message], [template])](#ErrrValidator.shouldNotBeString) ⇒ [ErrrDecorator](#ErrrDecorator) * [.shouldBeNumber(val, [message], [template])](#ErrrValidator.shouldBeNumber) ⇒ [ErrrDecorator](#ErrrDecorator) * [.shouldNotBeNumber(val, [message], [template])](#ErrrValidator.shouldNotBeNumber) ⇒ [ErrrDecorator](#ErrrDecorator) * [.shouldBeFinite(val, [message], [template])](#ErrrValidator.shouldBeFinite) ⇒ [ErrrDecorator](#ErrrDecorator) * [.shouldBeInfinite(val, [message], [template])](#ErrrValidator.shouldBeInfinite) ⇒ [ErrrDecorator](#ErrrDecorator) * [.shouldBeBoolean(val, [message], [template])](#ErrrValidator.shouldBeBoolean) ⇒ [ErrrDecorator](#ErrrDecorator) * [.shouldNotBeBoolean(val, [message], [template])](#ErrrValidator.shouldNotBeBoolean) ⇒ [ErrrDecorator](#ErrrDecorator) * [.shouldBeDate(val, [message], [template])](#ErrrValidator.shouldBeDate) ⇒ [ErrrDecorator](#ErrrDecorator) * [.shouldNotBeDate(val, [message], [template])](#ErrrValidator.shouldNotBeDate) ⇒ [ErrrDecorator](#ErrrDecorator) * [.shouldBeRegExp(val, [message], [template])](#ErrrValidator.shouldBeRegExp) ⇒ [ErrrDecorator](#ErrrDecorator) * [.shouldNotBeRegExp(val, [message], [template])](#ErrrValidator.shouldNotBeRegExp) ⇒ [ErrrDecorator](#ErrrDecorator) * [.shouldBeFalsey(val, [message], [template])](#ErrrValidator.shouldBeFalsey) ⇒ [ErrrDecorator](#ErrrDecorator) * [.shouldNotBeFalsey(val, [message], [template])](#ErrrValidator.shouldNotBeFalsey) ⇒ [ErrrDecorator](#ErrrDecorator) * [.shouldBeFalsy(val, [message], [template])](#ErrrValidator.shouldBeFalsy) ⇒ [ErrrDecorator](#ErrrDecorator) * [.shouldNotBeFalsy(val, [message], [template])](#ErrrValidator.shouldNotBeFalsy) ⇒ [ErrrDecorator](#ErrrDecorator) * [.shouldBeTruthy(val, [message], [template])](#ErrrValidator.shouldBeTruthy) ⇒ [ErrrDecorator](#ErrrDecorator) * [.shouldNotBeTruthy(val, [message], [template])](#ErrrValidator.shouldNotBeTruthy) ⇒ [ErrrDecorator](#ErrrDecorator) * [.checkArgument(expression, [message], [template])](#ErrrValidator.checkArgument) ⇒ [ErrrDecorator](#ErrrDecorator) * [.checkState(expression, [message], [template])](#ErrrValidator.checkState) ⇒ [ErrrDecorator](#ErrrDecorator) * [.checkElementIndex(index, size, [message], [template])](#ErrrValidator.checkElementIndex) ⇒ [ErrrDecorator](#ErrrDecorator) * [.checkPositionIndex(index, size, [message], [template])](#ErrrValidator.checkPositionIndex) ⇒ [ErrrDecorator](#ErrrDecorator) * [.checkPositionIndexes(start, end, size, [message], [template])](#ErrrValidator.checkPositionIndexes) ⇒ [ErrrDecorator](#ErrrDecorator) ### ErrrValidator.shouldBeDefined(val, [message], [template]) ⇒ [ErrrDecorator](#ErrrDecorator) Throws an error if 'val' is not defined. **Kind**: static method of [ErrrValidator](#ErrrValidator) **Returns**: [ErrrDecorator](#ErrrDecorator) - - An object that decorates the errr node module. | Param | Type | Description | | --- | --- | --- | | val | \* | The value to validate. | | [message] | String | The error message or the error template string to use if the ErrrValidator fails. | | [template] | Array | Template params. If provided, the error message will be generated using util.format(message, template). | ### ErrrValidator.shouldBeUndefined(val, [message], [template]) ⇒ [ErrrDecorator](#ErrrDecorator) Throws an error if 'val' is defined. **Kind**: static method of [ErrrValidator](#ErrrValidator) **Returns**: [ErrrDecorator](#ErrrDecorator) - - An object that decorates the errr node module. | Param | Type | Description | | --- | --- | --- | | val | String | The value to validate. | | [message] | String | The error message or the error template string to use if the ErrrValidator fails. | | [template] | Array | Template params. If provided, the error message will be generated using util.format(message, template). | ### ErrrValidator.shouldBeArray(val, [message], [template]) ⇒ [ErrrDecorator](#ErrrDecorator) Throws an error if 'val' is not of type Array. **Kind**: static method of [ErrrValidator](#ErrrValidator) **Returns**: [ErrrDecorator](#ErrrDecorator) - - An object that decorates the errr node module. | Param | Type | Description | | --- | --- | --- | | val | String | The value to validate. | | [message] | String | The error message or the error template string to use if the ErrrValidator fails. | | [template] | Array | Template params. If provided, the error message will be generated using util.format(message, template). | ### ErrrValidator.shouldNotBeArray(val, [message], [template]) ⇒ [ErrrDecorator](#ErrrDecorator) Throws an error if 'val' is of type Array. **Kind**: static method of [ErrrValidator](#ErrrValidator) **Returns**: [ErrrDecorator](#ErrrDecorator) - - An object that decorates the errr node module. | Param | Type | Description | | --- | --- | --- | | val | String | The value to validate. | | [message] | String | The error message or the error template string to use if the ErrrValidator fails. | | [template] | Array | Template params. If provided, the error message will be generated using util.format(message, template). | ### ErrrValidator.shouldBeObject(val, [message], [template]) ⇒ [ErrrDecorator](#ErrrDecorator) Throws an error if 'val' is not of type Object. **Kind**: static method of [ErrrValidator](#ErrrValidator) **Returns**: [ErrrDecorator](#ErrrDecorator) - - An object that decorates the errr node module. | Param | Type | Description | | --- | --- | --- | | val | String | The value to validate. | | [message] | String | The error message or the error template string to use if the ErrrValidator fails. | | [template] | Array | Template params. If provided, the error message will be generated using util.format(message, template). | ### ErrrValidator.shouldNotBeObject(val, [message], [template]) ⇒ [ErrrDecorator](#ErrrDecorator) Throws an error if 'val' is of type Object. **Kind**: static method of [ErrrValidator](#ErrrValidator) **Returns**: [ErrrDecorator](#ErrrDecorator) - - An object that decorates the errr node module. | Param | Type | Description | | --- | --- | --- | | val | String | The value to validate. | | [message] | String | The error message or the error template string to use if the ErrrValidator fails. | | [template] | Array | Template params. If provided, the error message will be generated using util.format(message, template). | ### ErrrValidator.shouldBeEmpty(val, [message], [template]) ⇒ [ErrrDecorator](#ErrrDecorator) Throws an error if 'val' is not empty. **Kind**: static method of [ErrrValidator](#ErrrValidator) **Returns**: [ErrrDecorator](#ErrrDecorator) - - An object that decorates the errr node module. | Param | Type | Description | | --- | --- | --- | | val | String | The value to validate. | | [message] | String | The error message or the error template string to use if the ErrrValidator fails. | | [template] | Array | Template params. If provided, the error message will be generated using util.format(message, template). | ### ErrrValidator.shouldNotBeEmpty(val, [message], [template]) ⇒ [ErrrDecorator](#ErrrDecorator) Throws an error if 'val' is empty. **Kind**: static method of [ErrrValidator](#ErrrValidator) **Returns**: [ErrrDecorator](#ErrrDecorator) - - An object that decorates the errr node module. | Param | Type | Description | | --- | --- | --- | | val | String | The value to validate. | | [message] | String | The error message or the error template string to use if the ErrrValidator fails. | | [template] | Array | Template params. If provided, the error message will be generated using util.format(message, template). | ### ErrrValidator.shouldBeFunction(val, [message], [template]) ⇒ [ErrrDecorator](#ErrrDecorator) Throws an error if 'val' is not of type Function. **Kind**: static method of [ErrrValidator](#ErrrValidator) **Returns**: [ErrrDecorator](#ErrrDecorator) - - An object that decorates the errr node module. | Param | Type | Description | | --- | --- | --- | | val | String | The value to validate. | | [message] | String | The error message or the error template string to use if the ErrrValidator fails. | | [template] | Array | Template params. If provided, the error message will be generated using util.format(message, template). | ### ErrrValidator.shouldNotBeFunction(val, [message], [template]) ⇒ [ErrrDecorator](#ErrrDecorator) Throws an error if 'val' is of type Function. **Kind**: static method of [ErrrValidator](#ErrrValidator) **Returns**: [ErrrDecorator](#ErrrDecorator) - - An object that decorates the errr node module. | Param | Type | Description | | --- | --- | --- | | val | String | The value to validate. | | [message] | String | The error message or the error template string to use if the ErrrValidator fails. | | [template] | Array | Template params. If provided, the error message will be generated using util.format(message, template). | ### ErrrValidator.shouldBeString(val, [message], [template]) ⇒ [ErrrDecorator](#ErrrDecorator) Throws an error if 'val' is not of type String. **Kind**: static method of [ErrrValidator](#ErrrValidator) **Returns**: [ErrrDecorator](#ErrrDecorator) - - An object that decorates the errr node module. | Param | Type | Description | | --- | --- | --- | | val | String | The value to validate. | | [message] | String | The error message or the error template string to use if the ErrrValidator fails. | | [template] | Array | Template params. If provided, the error message will be generated using util.format(message, template). | ### ErrrValidator.shouldNotBeString(val, [message], [template]) ⇒ [ErrrDecorator](#ErrrDecorator) Throws an error if 'val' is of type String. **Kind**: static method of [ErrrValidator](#ErrrValidator) **Returns**: [ErrrDecorator](#ErrrDecorator) - - An object that decorates the errr node module. | Param | Type | Description | | --- | --- | --- | | val | String | The value to validate. | | [message] | String | The error message or the error template string to use if the ErrrValidator fails. | | [template] | Array | Template params. If provided, the error message will be generated using util.format(message, template). | ### ErrrValidator.shouldBeNumber(val, [message], [template]) ⇒ [ErrrDecorator](#ErrrDecorator) Throws an error if 'val' is not of type Number. **Kind**: static method of [ErrrValidator](#ErrrValidator) **Returns**: [ErrrDecorator](#ErrrDecorator) - - An object that decorates the errr node module. | Param | Type | Description | | --- | --- | --- | | val | String | The value to validate. | | [message] | String | The error message or the error template string to use if the ErrrValidator fails. | | [template] | Array | Template params. If provided, the error message will be generated using util.format(message, template). | ### ErrrValidator.shouldNotBeNumber(val, [message], [template]) ⇒ [ErrrDecorator](#ErrrDecorator) Throws an error if 'val' is of type Number. **Kind**: static method of [ErrrValidator](#ErrrValidator) **Returns**: [ErrrDecorator](#ErrrDecorator) - - An object that decorates the errr node module. | Param | Type | Description | | --- | --- | --- | | val | String | The value to validate. | | [message] | String | The error message or the error template string to use if the ErrrValidator fails. | | [template] | Array | Template params. If provided, the error message will be generated using util.format(message, template). | ### ErrrValidator.shouldBeFinite(val, [message], [template]) ⇒ [ErrrDecorator](#ErrrDecorator) Throws an error if 'val' is not finite. **Kind**: static method of [ErrrValidator](#ErrrValidator) **Returns**: [ErrrDecorator](#ErrrDecorator) - - An object that decorates the errr node module. | Param | Type | Description | | --- | --- | --- | | val | String | The value to validate. | | [message] | String | The error message or the error template string to use if the ErrrValidator fails. | | [template] | Array | Template params. If provided, the error message will be generated using util.format(message, template). | ### ErrrValidator.shouldBeInfinite(val, [message], [template]) ⇒ [ErrrDecorator](#ErrrDecorator) Throws an error if 'val' is finite. **Kind**: static method of [ErrrValidator](#ErrrValidator) **Returns**: [ErrrDecorator](#ErrrDecorator) - - An object that decorates the errr node module. | Param | Type | Description | | --- | --- | --- | | val | String | The value to validate. | | [message] | String | The error message or the error template string to use if the ErrrValidator fails. | | [template] | Array | Template params. If provided, the error message will be generated using util.format(message, template). | ### ErrrValidator.shouldBeBoolean(val, [message], [template]) ⇒ [ErrrDecorator](#ErrrDecorator) Throws an error if 'val' is not of type Boolean. **Kind**: static method of [ErrrValidator](#ErrrValidator) **Returns**: [ErrrDecorator](#ErrrDecorator) - - An object that decorates the errr node module. | Param | Type | Description | | --- | --- | --- | | val | String | The value to validate. | | [message] | String | The error message or the error template string to use if the ErrrValidator fails. | | [template] | Array | Template params. If provided, the error message will be generated using util.format(message, template). | ### ErrrValidator.shouldNotBeBoolean(val, [message], [template]) ⇒ [ErrrDecorator](#ErrrDecorator) Throws an error if 'val' is of type Boolean. **Kind**: static method of [ErrrValidator](#ErrrValidator) **Returns**: [ErrrDecorator](#ErrrDecorator) - - An object that decorates the errr node module. | Param | Type | Description | | --- | --- | --- | | val | String | The value to validate. | | [message] | String | The error message or the error template string to use if the ErrrValidator fails. | | [template] | Array | Template params. If provided, the error message will be generated using util.format(message, template). | ### ErrrValidator.shouldBeDate(val, [message], [template]) ⇒ [ErrrDecorator](#ErrrDecorator) Throws an error if 'val' is not of type Date. **Kind**: static method of [ErrrValidator](#ErrrValidator) **Returns**: [ErrrDecorator](#ErrrDecorator) - - An object that decorates the errr node module. | Param | Type | Description | | --- | --- | --- | | val | String | The value to validate. | | [message] | String | The error message or the error template string to use if the ErrrValidator fails. | | [template] | Array | Template params. If provided, the error message will be generated using util.format(message, template). | ### ErrrValidator.shouldNotBeDate(val, [message], [template]) ⇒ [ErrrDecorator](#ErrrDecorator) Throws an error if 'val' is of type Date. **Kind**: static method of [ErrrValidator](#ErrrValidator) **Returns**: [ErrrDecorator](#ErrrDecorator) - - An object that decorates the errr node module. | Param | Type | Description | | --- | --- | --- | | val | String | The value to validate. | | [message] | String | The error message or the error template string to use if the ErrrValidator fails. | | [template] | Array | Template params. If provided, the error message will be generated using util.format(message, template). | ### ErrrValidator.shouldBeRegExp(val, [message], [template]) ⇒ [ErrrDecorator](#ErrrDecorator) Throws an error if 'val' is not a Regular Expression. **Kind**: static method of [ErrrValidator](#ErrrValidator) **Returns**: [ErrrDecorator](#ErrrDecorator) - - An object that decorates the errr node module. | Param | Type | Description | | --- | --- | --- | | val | String | The value to validate. | | [message] | String | The error message or the error template string to use if the ErrrValidator fails. | | [template] | Array | Template params. If provided, the error message will be generated using util.format(message, template). | ### ErrrValidator.shouldNotBeRegExp(val, [message], [template]) ⇒ [ErrrDecorator](#ErrrDecorator) Throws an error if 'val' is a Regular Expression. **Kind**: static method of [ErrrValidator](#ErrrValidator) **Returns**: [ErrrDecorator](#ErrrDecorator) - - An object that decorates the errr node module. | Param | Type | Description | | --- | --- | --- | | val | String | The value to validate. | | [message] | String | The error message or the error template string to use if the ErrrValidator fails. | | [template] | Array | Template params. If provided, the error message will be generated using util.format(message, template). | ### ErrrValidator.shouldBeFalsey(val, [message], [template]) ⇒ [ErrrDecorator](#ErrrDecorator) Throws an error if 'val' is not falsey. **Kind**: static method of [ErrrValidator](#ErrrValidator) **Returns**: [ErrrDecorator](#ErrrDecorator) - - An object that decorates the errr node module. | Param | Type | Description | | --- | --- | --- | | val | Any | The value to validate. | | [message] | String | The error message or the error template string to use if the ErrrValidator fails. | | [template] | Array | Template params. If provided, the error message will be generated using util.format(message, template). | ### ErrrValidator.shouldNotBeFalsey(val, [message], [template]) ⇒ [ErrrDecorator](#ErrrDecorator) Throws an error if 'val' is falsey. **Kind**: static method of [ErrrValidator](#ErrrValidator) **Returns**: [ErrrDecorator](#ErrrDecorator) - - An object that decorates the errr node module. | Param | Type | Description | | --- | --- | --- | | val | Any | The value to validate. | | [message] | String | The error message or the error template string to use if the ErrrValidator fails. | | [template] | Array | Template params. If provided, the error message will be generated using util.format(message, template). | ### ErrrValidator.shouldBeFalsy(val, [message], [template]) ⇒ [ErrrDecorator](#ErrrDecorator) Synonym for shouldBeFalsey. **Kind**: static method of [ErrrValidator](#ErrrValidator) **Returns**: [ErrrDecorator](#ErrrDecorator) - - An object that decorates the errr node module. | Param | Type | Description | | --- | --- | --- | | val | Any | The value to validate. | | [message] | String | The error message or the error template string to use if the ErrrValidator fails. | | [template] | Array | Template params. If provided, the error message will be generated using util.format(message, template). | ### ErrrValidator.shouldNotBeFalsy(val, [message], [template]) ⇒ [ErrrDecorator](#ErrrDecorator) Synonym for shouldNotBeFalsey. **Kind**: static method of [ErrrValidator](#ErrrValidator) **Returns**: [ErrrDecorator](#ErrrDecorator) - - An object that decorates the errr node module. | Param | Type | Description | | --- | --- | --- | | val | Any | The value to validate. | | [message] | String | The error message or the error template string to use if the ErrrValidator fails. | | [template] | Array | Template params. If provided, the error message will be generated using util.format(message, template). | ### ErrrValidator.shouldBeTruthy(val, [message], [template]) ⇒ [ErrrDecorator](#ErrrDecorator) Synonym for shouldNotBeFalsey. **Kind**: static method of [ErrrValidator](#ErrrValidator) **Returns**: [ErrrDecorator](#ErrrDecorator) - - An object that decorates the errr node module. | Param | Type | Description | | --- | --- | --- | | val | Any | The value to validate. | | [message] | String | The error message or the error template string to use if the ErrrValidator fails. | | [template] | Array | Template params. If provided, the error message will be generated using util.format(message, template). | ### ErrrValidator.shouldNotBeTruthy(val, [message], [template]) ⇒ [ErrrDecorator](#ErrrDecorator) Synonym for shouldBeFalsey. **Kind**: static method of [ErrrValidator](#ErrrValidator) **Returns**: [ErrrDecorator](#ErrrDecorator) - - An object that decorates the errr node module. | Param | Type | Description | | --- | --- | --- | | val | Any | The value to validate. | | [message] | String | The error message or the error template string to use if the ErrrValidator fails. | | [template] | Array | Template params. If provided, the error message will be generated using util.format(message, template). | ### ErrrValidator.checkArgument(expression, [message], [template]) ⇒ [ErrrDecorator](#ErrrDecorator) Ensures the truth of an expression involving one or more parameters to the calling method. **Kind**: static method of [ErrrValidator](#ErrrValidator) **Returns**: [ErrrDecorator](#ErrrDecorator) - - An object that decorates the errr node module. | Param | Type | Description | | --- | --- | --- | | expression | Any | The value to validate. | | [message] | String | The error message or the error template string to use if the ErrrValidator fails. | | [template] | Array | Template params. If provided, the error message will be generated using util.format(message, template). | ### ErrrValidator.checkState(expression, [message], [template]) ⇒ [ErrrDecorator](#ErrrDecorator) Ensures the truth of an expression involving the state of the calling instance, but not involving any parameters to the calling method. **Kind**: static method of [ErrrValidator](#ErrrValidator) **Returns**: [ErrrDecorator](#ErrrDecorator) - - An object that decorates the errr node module. | Param | Type | Description | | --- | --- | --- | | expression | Any | The value to validate. | | [message] | String | The error message or the error template string to use if the ErrrValidator fails. | | [template] | Array | Template params. If provided, the error message will be generated using util.format(message, template). | ### ErrrValidator.checkElementIndex(index, size, [message], [template]) ⇒ [ErrrDecorator](#ErrrDecorator) Ensures that index specifies a valid element in an array, list or string of size size. **Kind**: static method of [ErrrValidator](#ErrrValidator) **Returns**: [ErrrDecorator](#ErrrDecorator) - - An object that decorates the errr node module. | Param | Type | Description | | --- | --- | --- | | index | Number | | | size | Number | | | [message] | String | The error message or the error template string to use if the ErrrValidator fails. | | [template] | Array | Template params. If provided, the error message will be generated using util.format(message, template). | ### ErrrValidator.checkPositionIndex(index, size, [message], [template]) ⇒ [ErrrDecorator](#ErrrDecorator) Ensures that index specifies a valid position in an array, list or string of size size. **Kind**: static method of [ErrrValidator](#ErrrValidator) **Returns**: [ErrrDecorator](#ErrrDecorator) - - An object that decorates the errr node module. | Param | Type | Description | | --- | --- | --- | | index | Number | | | size | Number | | | [message] | String | The error message or the error template string to use if the ErrrValidator fails. | | [template] | Array | Template params. If provided, the error message will be generated using util.format(message, template). | ### ErrrValidator.checkPositionIndexes(start, end, size, [message], [template]) ⇒ [ErrrDecorator](#ErrrDecorator) Ensures that start and end specify a valid positions in an array, list or string of size size, and are in order. **Kind**: static method of [ErrrValidator](#ErrrValidator) **Returns**: [ErrrDecorator](#ErrrDecorator) - - An object that decorates the errr node module. | Param | Type | Description | | --- | --- | --- | | start | Number | | | end | Number | | | size | Number | | | [message] | String | The error message or the error template string to use if the ErrrValidator fails. | | [template] | Array | Template params. If provided, the error message will be generated using util.format(message, template). | ## Preconditions Preconditions entry point interface. **Kind**: global class * [Preconditions](#Preconditions) * [.errr()](#Preconditions.errr) ⇒ * [.singleton()](#Preconditions.singleton) ⇒ * [.instance(objectUnderTest)](#Preconditions.instance) ⇒ * [.getConstructor()](#Preconditions.getConstructor) ⇒ ### Preconditions.errr() ⇒ Validate single value with the buildable errr interface from the static errr Validation functionality. **Kind**: static method of [Preconditions](#Preconditions) **Returns**: Error Validation Singleton. ### Preconditions.singleton() ⇒ Validate single value with the chainable interface from the Error Validation Singleton. **Kind**: static method of [Preconditions](#Preconditions) **Returns**: Error Validation Singleton. ### Preconditions.instance(objectUnderTest) ⇒ **Kind**: static method of [Preconditions](#Preconditions) **Returns**: Error Validation instance. **Warning**: This functionality has very poor performance. Please use the 'singleton' or 'errr' functionality instead. Validate values of a given JSON object with the preconditions object. | Param | Description | | --- | --- | | objectUnderTest | Object Under Test | ### Preconditions.getConstructor() ⇒ Gives ability to extend and add other preconditions to the Error Validation constructor. **Kind**: static method of [Preconditions](#Preconditions) **Returns**: Error Validation constructor. **Warning**: This functionality only works with the 'instance' function which has very poor performance.