Class: BufferType

BufferType

new BufferType()

Generates a schema object that matches a Buffer data type
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

length(limit) → {BufferType}

Specifies the exact length of the buffer.
Parameters:
Name Type Description
limit Number The size of buffer allowed.
Source:
Returns:
The class reference so multiple calls can be chained.
Type
BufferType

max(limit) → {BufferType}

Specifies the maximum length of the buffer.
Parameters:
Name Type Description
limit Number The highest size of the buffer.
Source:
Returns:
The class reference so multiple calls can be chained.
Type
BufferType

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) → {BufferType}

Specifies the minimum length of the buffer.
Parameters:
Name Type Description
limit Number The lowest size of the buffer.
Source:
Returns:
The class reference so multiple calls can be chained.
Type
BufferType

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

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