OptionalValidator
Hierarchy
PatternValidator
↳ OptionalValidator
Implements
- PatternValidator
- PatternValidator
Index
Properties
Methods
Properties
Static describer
▪ describer: Describer
Inherited from PatternValidator.describer
Overrides void
Methods
canValidate
▸ canValidate(expectation: Expectation): boolean
Evaluates if validator can handle provided expectation.
Parameters:
| Name | Type | Description |
|---|---|---|
expectation | Expectation | Evaluated explicit Pattern instance or implicit expectation. |
Returns: boolean
Returns true if pattern is instance of Optional, else false.
describe
▸ describe(value: any): string
Inherited from PatternValidator.describe
Overrides void
Parameters:
| Name | Type |
|---|---|
value | any |
Returns: string
validate
▸ validate(value: any, optional: Optional, validator: Validator): boolean
Implementation of PatternValidator
Validates if value is undefined or matches the expectation.
throws {ValidationError}
Thrown if the argument is not undefined or not matching expectation.
Parameters:
| Name | Type | Description |
|---|---|---|
value | any | Value that is validated against expectation. |
optional | Optional | Explicit pattern as Optional instance. |
validator | Validator | Validator matching Validator interface. |
Returns: boolean
Returns true if value is an undefined or matches 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