Class: MapValidator<K, V>
Type parameters
Name |
---|
K |
V |
Hierarchy
-
BaseValidator
<Map
<K
,V
>>↳
MapValidator
Constructors
constructor
• new MapValidator<K
, V
>(keyValidator
, valueValidator
, constraints?
): MapValidator
<K
, V
>
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 >>[] | [] |
Returns
MapValidator
<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:17
description
• Optional
description: string
Inherited from
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:15
isValidationEnabled
• Protected
isValidationEnabled: null
| boolean
| () => boolean
= null
Inherited from
BaseValidator.isValidationEnabled
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:18
keyValidator
• Private
Readonly
keyValidator: BaseValidator
<K
>
Defined in
projects/shapeshift/src/validators/MapValidator.ts:9
parent
• Protected
Optional
parent: object
Inherited from
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:16
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:41
nullable
• get
nullable(): UnionValidator
<null
| T
>
Returns
UnionValidator
<null
| T
>
Inherited from
BaseValidator.nullable
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:33
nullish
• get
nullish(): UnionValidator
<undefined
| null
| T
>
Returns
UnionValidator
<undefined
| null
| T
>
Inherited from
BaseValidator.nullish
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:37
optional
• get
optional(): UnionValidator
<undefined
| T
>
Returns
UnionValidator
<undefined
| T
>
Inherited from
BaseValidator.optional
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:29
set
• get
set(): SetValidator
<T
>
Returns
SetValidator
<T
>
Inherited from
BaseValidator.set
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:45
shouldRunConstraints
• get
shouldRunConstraints(): boolean
Returns
boolean
Inherited from
BaseValidator.shouldRunConstraints
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:120
Methods
addConstraint
▸ 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:132
clone
▸ 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:65
describe
▸ describe(description
): MapValidator
<K
, V
>
Parameters
Name | Type |
---|---|
description | string |
Returns
MapValidator
<K
, V
>
Inherited from
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:73
getValidationEnabled
▸ getValidationEnabled(): null
| boolean
Returns
null
| boolean
Inherited from
BaseValidator.getValidationEnabled
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:116
handle
▸ handle(value
): Result
<Map
<K
, V
>, ValidationError
| CombinedPropertyError
>
Parameters
Name | Type |
---|---|
value | unknown |
Returns
Result
<Map
<K
, V
>, ValidationError
| CombinedPropertyError
>
Overrides
Defined in
projects/shapeshift/src/validators/MapValidator.ts:22
is
▸ is<R
>(value
): value is R
Type parameters
Name | Type |
---|---|
R | extends Map <K , V > = Map <K , V > |
Parameters
Name | Type |
---|---|
value | unknown |
Returns
value is R
Inherited from
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:101
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:49
parse
▸ parse<R
>(value
): R
Type parameters
Name | Type |
---|---|
R | extends Map <K , V > = Map <K , V > |
Parameters
Name | Type |
---|---|
value | unknown |
Returns
R
Inherited from
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:91
reshape
▸ reshape(cb
): MapValidator
<K
, V
>
Parameters
Name | Type |
---|---|
cb | (input : Map <K , V >) => Result <Map <K , V >, Error > |
Returns
MapValidator
<K
, V
>
Inherited from
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:59
▸ reshape<R
, O
>(cb
): BaseValidator
<O
>
Type parameters
Name | Type |
---|---|
R | extends Result <unknown , Error > |
O | InferResultType <R > |
Parameters
Name | Type |
---|---|
cb | (input : Map <K , V >) => R |
Returns
Inherited from
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:60
run
▸ run(value
): Result
<Map
<K
, V
>, BaseError
>
Parameters
Name | Type |
---|---|
value | unknown |
Returns
Inherited from
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:79
setParent
▸ setParent(parent
): MapValidator
<K
, V
>
Parameters
Name | Type |
---|---|
parent | object |
Returns
MapValidator
<K
, V
>
Inherited from
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:24
setValidationEnabled
▸ setValidationEnabled(isValidationEnabled
): MapValidator
<K
, V
>
Sets if the validator should also run constraints or just do basic checks.
Parameters
Name | Type | Description |
---|---|---|
isValidationEnabled | null | boolean | () => boolean | Whether this validator should be enabled or disabled. You can pass boolean or a function returning boolean which will be called just before parsing. Set to null to go off of the global configuration. |
Returns
MapValidator
<K
, V
>
Inherited from
BaseValidator.setValidationEnabled
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:110
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:53
▸ transform<O
>(cb
): BaseValidator
<O
>
Type parameters
Name |
---|
O |
Parameters
Name | Type |
---|---|
cb | (value : Map <K , V >) => O |
Returns
Inherited from
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:54
when
▸ when<Key
, This
>(key
, options
): MapValidator
<K
, V
>
Type parameters
Name | Type |
---|---|
Key | extends WhenKey |
This | extends BaseValidator <any > = MapValidator <K , V > |
Parameters
Name | Type |
---|---|
key | Key |
options | WhenOptions <This , Key > |
Returns
MapValidator
<K
, V
>