EqualsValidator

Hierarchy

• PatternValidator

• PatternValidator

  ↳ EqualsValidator

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 Equals, definition is Error instance, is not array or plain object; else false.

---

describe

▸ describe(value: any): string

Inherited from PatternValidator.describe

Overrides void

Parameters:

Name	Type
value	any

Returns: string

---

validate

▸ validate(value: any, equalsOrExpect: Expectation): boolean

Validates if value is equal to expectation.

throws {InvalidTypeError} Thrown if the value is an array(use List, Tuple, OneOf patterns for array values).

throws {InvalidTypeError} Thrown if the value is a plain object(use Collection pattern for object values).

throws {UnequalValueError} Thrown if the value is not equal to the expectation.

Parameters:

Name	Type	Description
value	any	Value that is validated against expectation.
equalsOrExpect	Expectation	Explicit pattern as Equals instance or implicit expectation against which value is validated.

Returns: boolean

Returns true if value is equal to expectation, 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