tb Class: ArrayNode

new ArrayNode(key, parent)

Parameters:

Name	Type	Description
`key`	string
`parent`	MixedNode

Source:

lib/node/array.js, line 13

Extends

MixedNode

Members

description

Sets the description

Inherited From:

MixedNode#description

Source:

lib/node/mixed.js, line 35

Methods

always() → {Condition}

Inherited From:

MixedNode#always

Source:

lib/node/mixed.js, line 210

Returns:

Type: Condition

defaultValue(value) → {MixedNode}

Defines the default value for this entity

Parameters:

Name	Type	Description
`value`	mixed

Inherited From:

MixedNode#defaultValue

Source:

lib/node/mixed.js, line 104

Returns:

Type: MixedNode

end() → {MixedNode}

Returns the parent context

Inherited From:

MixedNode#end

Source:

lib/node/mixed.js, line 221

Returns:

Type: MixedNode

hasKey(key) → {ArrayNode}

Defines that this array must contain key

Parameters:

Name	Type	Description
`key`	string

Source:

lib/node/array.js, line 43

Returns:

Type: ArrayNode

ifArray() → {Condition}

Inherited From:

MixedNode#ifArray

Source:

lib/node/mixed.js, line 183

Returns:

Type: Condition

ifInArray() → {Condition}

Inherited From:

MixedNode#ifInArray

Source:

lib/node/mixed.js, line 201

Returns:

Type: Condition

ifNotInArray() → {Condition}

Inherited From:

MixedNode#ifNotInArray

Source:

lib/node/mixed.js, line 192

Returns:

Type: Condition

ifNull() → {Condition}

Inherited From:

MixedNode#ifNull

Source:

lib/node/mixed.js, line 174

Returns:

Type: Condition

ifString() → {Condition}

Inherited From:

MixedNode#ifString

Source:

lib/node/mixed.js, line 165

Returns:

Type: Condition

ifTrue() → {Condition}

Inherited From:

MixedNode#ifTrue

Source:

lib/node/mixed.js, line 156

Returns:

Type: Condition

isRequired() → {MixedNode}

Mark this entity as required

Inherited From:

MixedNode#isRequired

Source:

lib/node/mixed.js, line 114

Returns:

Type: MixedNode

lengthOf(value) → {ArrayNode}

Defines the required length of this array node

Parameters:

Name	Type	Description
`value`	number

Source:

lib/node/array.js, line 54

Returns:

Type: ArrayNode

maxLength(value) → {ArrayNode}

Defines the max length of this array node

Parameters:

Name	Type	Description
`value`	number

Source:

lib/node/array.js, line 76

Returns:

Type: ArrayNode

minLength(value) → {ArrayNode}

Defines the min length of this array node

Parameters:

Name	Type	Description
`value`	number

Source:

lib/node/array.js, line 65

Returns:

Type: ArrayNode

nestedObject() → {Context}

Returns the current context

Source:

lib/node/array.js, line 33

Returns:

Type: Context

sanitizer(callback) → {MixedNode}

Setup a sanitizer function

Parameters:

Name	Type	Description
`callback`	function

Inherited From:

MixedNode#sanitizer

Source:

lib/node/mixed.js, line 89

Returns:

Type: MixedNode

validator(callback) → {MixedNode}

Sets the validator function

Parameters:

Name	Type	Description
`callback`	function

Inherited From:

MixedNode#validator

Source:

lib/node/mixed.js, line 46

Returns:

Type: MixedNode

validatorIf(condition, validator) → {MixedNode}

Sets a conditional validator

Parameters:

Name	Type	Description
`condition`	function
`validator`	function

Inherited From:

MixedNode#validatorIf

Source:

lib/node/mixed.js, line 62

Returns:

Type: MixedNode

when(condition) → {Condition}

Parameters:

Name	Type	Description
`condition`	function

Inherited From:

MixedNode#when

Source:

lib/node/mixed.js, line 149

Returns:

Type: Condition