Class: ArrayType

ArrayType

new ArrayType()

Generates a schema object that matches an array data type. Note that undefined values inside arrays are not allowed by default but can be by using sparse().
Source:

Extends

Methods

allow(value) → {Type}

Whitelists the provided values.
Parameters:
Name Type Description
value * | Array.<*> The values to add to the whitelist. It can be an array of values, or multiple values can be passed as individual arguments.
Inherited From:
Source:
Returns:
The class reference so multiple calls can be chained.
Type
Type

forbidden() → {Type}

Marks a key as forbidden which will not allow any value except undefined. Used to explicitly forbid keys.
Inherited From:
Source:
Returns:
The class reference so multiple calls can be chained.
Type
Type

getRules() → {Object}

Gets a cloned version of the internal rules of this type.
Inherited From:
Source:
Returns:
The internal rules.
Type
Object

invalid(value) → {Type}

Blacklists the provided values.
Parameters:
Name Type Description
value * | Array.<*> The values to add to the blacklist. It can be an array of values, or multiple values can be passed as individual arguments.
Inherited From:
Source:
Returns:
The class reference so multiple calls can be chained.
Type
Type

items(type) → {ArrayType}

List the types allowed for the array values.
Parameters:
Name Type Description
type Type | Array.<Type> A schema object to validate each array item against. Type can be an array of values, or multiple values can be passed as individual arguments.
Source:
Returns:
The class reference so multiple calls can be chained.
Type
ArrayType

length(limit) → {ArrayType}

Specifies the exact number of items in the array.
Parameters:
Name Type Description
limit Number The number of array items allowed.
Source:
Returns:
The class reference so multiple calls can be chained.
Type
ArrayType

max(limit) → {ArrayType}

Specifies the maximum number of items in the array.
Parameters:
Name Type Description
limit Number The highest number of array items allowed.
Source:
Returns:
The class reference so multiple calls can be chained.
Type
ArrayType

mergeRules(rules) → {Type}

Merges the internal rules of this type with the argument passed.
Parameters:
Name Type Description
rules Object Internal rules as a plain object.
Inherited From:
Source:
Returns:
The class reference so multiple calls can be chained.
Type
Type

min(limit) → {ArrayType}

Specifies the minimum number of items in the array.
Parameters:
Name Type Description
limit Number The lowest number of array items allowed.
Source:
Returns:
The class reference so multiple calls can be chained.
Type
ArrayType

optional() → {Type}

Marks a key as optional which will allow undefined as values. Used to annotate the schema for readability as all keys are optional by default.
Inherited From:
Source:
Returns:
The class reference so multiple calls can be chained.
Type
Type

required() → {Type}

Marks a key as required which will not allow undefined as value. All keys are optional by default.
Inherited From:
Source:
Returns:
The class reference so multiple calls can be chained.
Type
Type

setRules(rules) → {Type}

Sets the internal rules of this type using a plain object.
Parameters:
Name Type Description
rules Object Internal rules as a plain object.
Inherited From:
Source:
Returns:
The class reference so multiple calls can be chained.
Type
Type

sparse(enabledopt) → {ArrayType}

Allow this array to be sparse.
Parameters:
Name Type Attributes Description
enabled Boolean <optional>
 Can be used with a falsy value to go back to the default behavior.
Source:
Returns:
The class reference so multiple calls can be chained.
Type
ArrayType

valid(value) → {Type}

Adds the provided values into the allowed whitelist and marks them as the only valid values allowed.
Parameters:
Name Type Description
value * | Array.<*> The values to add to the whitelist. It can be an array of values, or multiple values can be passed as individual arguments.
Inherited From:
Source:
Returns:
The class reference so multiple calls can be chained.
Type
Type

validate(…value) → {Boolean}

Validates the passed arguments.
Parameters:
Name Type Attributes Description
value * <repeatable>
 The value.
Inherited From:
Source:
Returns:
Returns true if all arguments are successfully validated, else false.
Type
Boolean

validateList(valuesList) → {Boolean}

Validates an array of values.
Parameters:
Name Type Description
valuesList Array.<*> The array of values.
Inherited From:
Source:
Returns:
Returns true if all elements in the array are successfully validated, else false.
Type
Boolean