Class: MapValidator<K, V>

Extends

• BaseValidator <Map ↗️<K, V>>

Type parameters

Type parameter
K
V

Constructors

new MapValidator()

new MapValidator<K, V>(keyValidator: BaseValidator<K>, valueValidator: BaseValidator<V>, constraints: readonly IConstraint <Map ↗️<K, V>, Map ↗️<K, V>>[]): MapValidator<K, V>

Parameters

Parameter	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

BaseValidator . constructor

Source

projects/shapeshift/src/validators/MapValidator.ts:12

Properties

constraints

protected constraints: readonly IConstraint <Map ↗️<K, V>, Map ↗️<K, V>>[] = []

Inherited from

BaseValidator . constraints

Source

projects/shapeshift/src/validators/BaseValidator.ts:17

---

description?

optional description: string

Inherited from

BaseValidator . description

Source

projects/shapeshift/src/validators/BaseValidator.ts:15

---

isValidationEnabled

protected isValidationEnabled: null | boolean | () => boolean = null

Inherited from

BaseValidator . isValidationEnabled

Source

projects/shapeshift/src/validators/BaseValidator.ts:18

---

keyValidator

private readonly keyValidator: BaseValidator<K>

Source

projects/shapeshift/src/validators/MapValidator.ts:9

---

parent?

protected optional parent: object

Inherited from

BaseValidator . parent

Source

projects/shapeshift/src/validators/BaseValidator.ts:16

---

valueValidator

private readonly valueValidator: BaseValidator<V>

Source

projects/shapeshift/src/validators/MapValidator.ts:10

Accessors

array

get array(): ArrayValidator<T[], T>

Returns

ArrayValidator<T[], T>

Source

projects/shapeshift/src/validators/BaseValidator.ts:41

---

nullable

get nullable(): UnionValidator<null | T>

Returns

UnionValidator<null | T>

Source

projects/shapeshift/src/validators/BaseValidator.ts:33

---

nullish

get nullish(): UnionValidator<undefined | null | T>

Returns

UnionValidator<undefined | null | T>

Source

projects/shapeshift/src/validators/BaseValidator.ts:37

---

optional

get optional(): UnionValidator<undefined | T>

Returns

UnionValidator<undefined | T>

Source

projects/shapeshift/src/validators/BaseValidator.ts:29

---

set

get set(): SetValidator<T>

Returns

SetValidator<T>

Source

projects/shapeshift/src/validators/BaseValidator.ts:45

---

shouldRunConstraints

get protected shouldRunConstraints(): boolean

Returns

boolean

Source

projects/shapeshift/src/validators/BaseValidator.ts:120

Methods

addConstraint()

protected addConstraint(constraint: IConstraint <Map ↗️<K, V>, Map ↗️<K, V>>): this

Parameters

Parameter	Type
constraint	IConstraint <Map ↗️<K, V>, Map ↗️<K, V>>

Returns

this

Inherited from

BaseValidator . addConstraint

Source

projects/shapeshift/src/validators/BaseValidator.ts:132

---

clone()

protected clone(): this

Returns

this

Overrides

BaseValidator . clone

Source

projects/shapeshift/src/validators/MapValidator.ts:18

---

default()

default(value: Map ↗️<K, V> | () => Map ↗️<K, V>): DefaultValidator <Map ↗️<K, V>>

Parameters

Parameter	Type
value	Map ↗️<K, V> | () => Map ↗️<K, V>

Returns

DefaultValidator <Map ↗️<K, V>>

Inherited from

BaseValidator . default

Source

projects/shapeshift/src/validators/BaseValidator.ts:65

---

describe()

describe(description: string): this

Parameters

Parameter	Type
description	string

Returns

this

Inherited from

BaseValidator . describe

Source

projects/shapeshift/src/validators/BaseValidator.ts:73

---

getValidationEnabled()

getValidationEnabled(): null | boolean

Returns

null | boolean

Inherited from

BaseValidator . getValidationEnabled

Source

projects/shapeshift/src/validators/BaseValidator.ts:116

---

handle()

protected handle(value: unknown): Result <Map ↗️<K, V>, ValidationError | CombinedPropertyError>

Parameters

Parameter	Type
value	unknown

Returns

Result <Map ↗️<K, V>, ValidationError | CombinedPropertyError>

Overrides

BaseValidator . handle

Source

projects/shapeshift/src/validators/MapValidator.ts:22

---

is()

is<R>(value: unknown): value is R

Type parameters

Type parameter	Value
R extends Map ↗️<K, V>	Map ↗️<K, V>

Parameters

Parameter	Type
value	unknown

Returns

value is R

Inherited from

BaseValidator . is

Source

projects/shapeshift/src/validators/BaseValidator.ts:101

---

or()

or<O>(...predicates: readonly BaseValidator<O>[]): UnionValidator <Map ↗️<K, V> | O>

Type parameters

Type parameter
O

Parameters

Parameter	Type
...predicates	readonly BaseValidator<O>[]

Returns

UnionValidator <Map ↗️<K, V> | O>

Inherited from

BaseValidator . or

Source

projects/shapeshift/src/validators/BaseValidator.ts:49

---

parse()

parse<R>(value: unknown): R

Type parameters

Type parameter	Value
R extends Map ↗️<K, V>	Map ↗️<K, V>

Parameters

Parameter	Type
value	unknown

Returns

R

Inherited from

BaseValidator . parse

Source

projects/shapeshift/src/validators/BaseValidator.ts:91

---

reshape()

reshape(cb)

reshape(cb: (input: Map ↗️<K, V>) => Result <Map ↗️<K, V>, Error ↗️>): this

Parameters

Parameter	Type
cb	(input: Map ↗️<K, V>) => Result <Map ↗️<K, V>, Error ↗️>

Returns

this

Inherited from

BaseValidator . reshape

Source

projects/shapeshift/src/validators/BaseValidator.ts:59

reshape(cb)

reshape<R, O>(cb: (input: Map ↗️<K, V>) => R): BaseValidator<O>

Type parameters

Type parameter	Value
R extends Result<unknown, Error ↗️>	-
O	InferResultType<R>

Parameters

Parameter	Type
cb	(input: Map ↗️<K, V>) => R

Returns

BaseValidator<O>

Inherited from

BaseValidator . reshape

Source

projects/shapeshift/src/validators/BaseValidator.ts:60

---

run()

run(value: unknown): Result <Map ↗️<K, V>, BaseError>

Parameters

Parameter	Type
value	unknown

Returns

Result <Map ↗️<K, V>, BaseError>

Inherited from

BaseValidator . run

Source

projects/shapeshift/src/validators/BaseValidator.ts:79

---

setParent()

setParent(parent: object): this

Parameters

Parameter	Type
parent	object

Returns

this

Inherited from

BaseValidator . setParent

Source

projects/shapeshift/src/validators/BaseValidator.ts:24

---

setValidationEnabled()

setValidationEnabled(isValidationEnabled: null | boolean | () => boolean): this

Sets if the validator should also run constraints or just do basic checks.

Parameters

Parameter	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

this

Inherited from

BaseValidator . setValidationEnabled

Source

projects/shapeshift/src/validators/BaseValidator.ts:110

---

transform()

transform(cb)

transform(cb: (value: Map ↗️<K, V>) => Map ↗️<K, V>): this

Parameters

Parameter	Type
cb	(value: Map ↗️<K, V>) => Map ↗️<K, V>

Returns

this

Inherited from

BaseValidator . transform

Source

projects/shapeshift/src/validators/BaseValidator.ts:53

transform(cb)

transform<O>(cb: (value: Map ↗️<K, V>) => O): BaseValidator<O>

Type parameters

Type parameter
O

Parameters

Parameter	Type
cb	(value: Map ↗️<K, V>) => O

Returns

BaseValidator<O>

Inherited from

BaseValidator . transform

Source

projects/shapeshift/src/validators/BaseValidator.ts:54

---

when()

when<Key, This>(key: Key, options: WhenOptions<This, Key>): this

Type parameters

Type parameter	Value
Key extends WhenKey	-
This extends BaseValidator<any>	MapValidator<K, V>

Parameters

Parameter	Type
key	Key
options	WhenOptions<This, Key>

Returns

this

Inherited from

BaseValidator . when

Source

projects/shapeshift/src/validators/BaseValidator.ts:69