Class: MapValidator<K, V>
Type parameters
Name |
---|
K |
V |
Hierarchy
BaseValidator
<Map
<K
,V
>>↳
MapValidator
Constructors
constructor
• new MapValidator<K
, V
>(keyValidator
, valueValidator
, constraints?
)
Type parameters
Name |
---|
K |
V |
Parameters
Name | Type | Default value |
---|---|---|
keyValidator | BaseValidator <K > | undefined |
valueValidator | BaseValidator <V > | undefined |
constraints | readonly IConstraint <Map <K , V >, Map <K , V >>[] | [] |
Overrides
Defined in
projects/shapeshift/src/validators/MapValidator.ts:12
Properties
constraints
• Protected
constraints: readonly IConstraint
<Map
<K
, V
>, Map
<K
, V
>>[] = []
Inherited from
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:13
isValidationEnabled
• Protected
isValidationEnabled: null
| boolean
| () => boolean
= null
Inherited from
BaseValidator.isValidationEnabled
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:14
keyValidator
• Private
Readonly
keyValidator: BaseValidator
<K
>
Defined in
projects/shapeshift/src/validators/MapValidator.ts:9
valueValidator
• Private
Readonly
valueValidator: BaseValidator
<V
>
Defined in
projects/shapeshift/src/validators/MapValidator.ts:10
Accessors
array
• get
array(): ArrayValidator
<T
[], T
>
Returns
ArrayValidator
<T
[], T
>
Inherited from
BaseValidator.array
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:32
nullable
• get
nullable(): UnionValidator
<null
| T
>
Returns
UnionValidator
<null
| T
>
Inherited from
BaseValidator.nullable
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:24
nullish
• get
nullish(): UnionValidator
<undefined
| null
| T
>
Returns
UnionValidator
<undefined
| null
| T
>
Inherited from
BaseValidator.nullish
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:28
optional
• get
optional(): UnionValidator
<undefined
| T
>
Returns
UnionValidator
<undefined
| T
>
Inherited from
BaseValidator.optional
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:20
set
• get
set(): SetValidator
<T
>
Returns
SetValidator
<T
>
Inherited from
BaseValidator.set
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:36
shouldRunConstraints
• Protected
get
shouldRunConstraints(): boolean
Returns
boolean
Inherited from
BaseValidator.shouldRunConstraints
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:91
Methods
addConstraint
▸ Protected
addConstraint(constraint
): MapValidator
<K
, V
>
Parameters
Name | Type |
---|---|
constraint | IConstraint <Map <K , V >, Map <K , V >> |
Returns
MapValidator
<K
, V
>
Inherited from
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:103
clone
▸ Protected
clone(): MapValidator
<K
, V
>
Returns
MapValidator
<K
, V
>
Overrides
Defined in
projects/shapeshift/src/validators/MapValidator.ts:18
default
▸ default(value
): DefaultValidator
<Map
<K
, V
>>
Parameters
Name | Type |
---|---|
value | Map <K , V > | () => Map <K , V > |
Returns
DefaultValidator
<Map
<K
, V
>>
Inherited from
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:50
getValidationEnabled
▸ getValidationEnabled(): null
| boolean
Returns
null
| boolean
Inherited from
BaseValidator.getValidationEnabled
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:87
handle
▸ Protected
handle(value
): Result
<Map
<K
, V
>, CombinedPropertyError
| ValidationError
>
Parameters
Name | Type |
---|---|
value | unknown |
Returns
Result
<Map
<K
, V
>, CombinedPropertyError
| ValidationError
>
Overrides
Defined in
projects/shapeshift/src/validators/MapValidator.ts:22
or
▸ or<O
>(...predicates
): UnionValidator
<Map
<K
, V
> | O
>
Type parameters
Name |
---|
O |
Parameters
Name | Type |
---|---|
...predicates | readonly BaseValidator <O >[] |
Returns
UnionValidator
<Map
<K
, V
> | O
>
Inherited from
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:40
parse
▸ parse<R
>(value
): R
Type parameters
Name | Type |
---|---|
R | extends Map <K , V , R > = Map <K , V > |
Parameters
Name | Type |
---|---|
value | unknown |
Returns
R
Inherited from
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:66
run
▸ run(value
): Result
<Map
<K
, V
>, BaseError
>
Parameters
Name | Type |
---|---|
value | unknown |
Returns
Inherited from
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:54
setValidationEnabled
▸ setValidationEnabled(isValidationEnabled
): MapValidator
<K
, V
>
Parameters
Name | Type | Description |
---|---|---|
isValidationEnabled | null | boolean | () => boolean |
Returns
MapValidator
<K
, V
>
Inherited from
BaseValidator.setValidationEnabled
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:81
transform
▸ transform(cb
): MapValidator
<K
, V
>
Parameters
Name | Type |
---|---|
cb | (value : Map <K , V >) => Map <K , V > |
Returns
MapValidator
<K
, V
>
Inherited from
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:44
▸ transform<O
>(cb
): BaseValidator
<O
>
Type parameters
Name |
---|
O |
Parameters
Name | Type |
---|---|
cb | (value : Map <K , V >) => O |