CollectionWithinValidator
Hierarchy
PatternValidator
↳ CollectionWithinValidator
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 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 CollectionWithin, else false.
describe
▸ describe(value: any): string
Inherited from PatternValidator.describe
Overrides void
Parameters:
| Name | Type |
|---|---|
value | any |
Returns: string
validate
▸ validate(value: any, collectionWithin: CollectionWithin, validator: Validator): boolean
Implementation of PatternValidator
Validates if value matches an Object with expected keys and values matching
the given expectations.
The value may also contain other keys with arbitrary values not defined in
pattern(equivalent of Meteor's Match.ObjectIncluding).
It also can omit nested Object properties(useful for building up
configuration a like objects).
throws {InvalidTypeError}
Thrown if the value is not an object.
throws {ValidationError}
Thrown if the value does not match properties.
Parameters:
| Name | Type | Description |
|---|---|---|
value | any | Value that is validated against expectation. |
collectionWithin | CollectionWithin | Explicit pattern as CollectionWithin instance. |
validator | Validator | Validator matching Validator interface. |
Returns: boolean
Returns true if value is matching explicit CollectionWithin pattern even on nested missing object properties, 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