ListValidator

Hierarchy

• PatternValidator

• PatternValidator

  ↳ ListValidator

Implements

• PatternValidator
• PatternValidator

Index

Properties

• describer

Methods

• canValidate
• describe
• validate
• getDescriber
• setDescriber

Properties

Static describer

▪ describer: Describer

Inherited from PatternValidator.describer

Overrides void

Methods

canValidate

▸ canValidate(expectation: Expectation): boolean

Evaluates if validator can handle provided explicit pattern or implicit expectation.

Parameters:

Name	Type	Description
expectation	Expectation	Evaluated explicit Pattern instance or implicit expectation.

Returns: boolean

Returns true if pattern is instance of List or expectation matches array with value or its Array constructor, else false.

---

describe

▸ describe(value: any): string

Inherited from PatternValidator.describe

Overrides void

Parameters:

Name	Type
value	any

Returns: string

---

validate

▸ validate(value: any, listOrExpect: List | any[] | any, validator: Validator): boolean

Validates if value matches list expectation.

throws {InvalidTypeError} Thrown if the value is not an array.

throws {ValidationError} Thrown if the value does not match expectation.

Parameters:

Name	Type	Description
value	any	Value that is validated against expectation.
listOrExpect	List | any[] | any	-Explicit pattern as List instance or implicit expectation against which value is validated.
validator	Validator	Validator matching Validator interface.

Returns: boolean

Returns true if value is matching definition, else throws.

---

Static getDescriber

▸ getDescriber(): Describer

Inherited from PatternValidator.getDescriber

Overrides void

Returns: Describer

---

Static setDescriber

▸ setDescriber(describer: Describer): void

Inherited from PatternValidator.setDescriber

Overrides void

Parameters:

Name	Type
describer	Describer

Returns: void