Abstract Interface: BaseValidator<T>

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

Extended by

• ArrayValidator
• BigIntValidator
• BooleanValidator
• DateValidator
• DefaultValidator
• InstanceValidator
• LiteralValidator
• MapValidator
• NativeEnumValidator
• NeverValidator
• NullishValidator
• NumberValidator
• ObjectValidator
• PassthroughValidator
• RecordValidator
• SetValidator
• StringValidator
• TupleValidator
• TypedArrayValidator
• UnionValidator

Type Parameters

Type Parameter
T

Properties

constraints

protected constraints: readonly IConstraint<T, T>[] = []

Defined in: projects/shapeshift/src/validators/BaseValidator.ts:19

---

description?

optional description: string

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

---

isValidationEnabled

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

Defined in: projects/shapeshift/src/validators/BaseValidator.ts:20

---

parent?

protected optional parent: object

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

---

validatorOptions

protected validatorOptions: ValidatorOptions

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

Accessors

shouldRunConstraints

Get Signature

get protected shouldRunConstraints(): boolean

Defined in: projects/shapeshift/src/validators/BaseValidator.ts:143

Returns

boolean

Methods

addConstraint()

protected addConstraint(constraint: IConstraint<T>, validatorOptions: ValidatorOptions): this

Defined in: projects/shapeshift/src/validators/BaseValidator.ts:155

Parameters

Parameter	Type
constraint	IConstraint<T>
validatorOptions	ValidatorOptions

Returns

this

---

array()

array(options: ValidatorOptions): ArrayValidator<T[]>

Defined in: projects/shapeshift/src/validators/BaseValidator.ts:44

Parameters

Parameter	Type
options	ValidatorOptions

Returns

ArrayValidator<T[]>

---

clone()

protected clone(): this

Defined in: projects/shapeshift/src/validators/BaseValidator.ts:147

Returns

this

---

default()

default(value: Exclude<T, undefined> | () => Exclude<T, undefined>, options: ValidatorOptions): DefaultValidator<Exclude<T, undefined>>

Defined in: projects/shapeshift/src/validators/BaseValidator.ts:81

Parameters

Parameter	Type
value	Exclude<T, undefined> | () => Exclude<T, undefined>
options	ValidatorOptions

Returns

DefaultValidator<Exclude<T, undefined>>

---

describe()

describe(description: string): this

Defined in: projects/shapeshift/src/validators/BaseValidator.ts:96

Parameters

Parameter	Type
description	string

Returns

this

---

getValidationEnabled()

getValidationEnabled(): null | boolean

Defined in: projects/shapeshift/src/validators/BaseValidator.ts:139

Returns

null | boolean

---

handle()

abstract protected handle(value: unknown): Result<T, ValidatorError>

Defined in: projects/shapeshift/src/validators/BaseValidator.ts:153

Parameters

Parameter	Type
value	unknown

Returns

Result<T, ValidatorError>

---

is()

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

Defined in: projects/shapeshift/src/validators/BaseValidator.ts:124

Type Parameters

Type Parameter	Default type
R	T

Parameters

Parameter	Type
value	unknown

Returns

value is R

---

nullable()

nullable(options: ValidatorOptions): UnionValidator<null | T>

Defined in: projects/shapeshift/src/validators/BaseValidator.ts:36

Parameters

Parameter	Type
options	ValidatorOptions

Returns

UnionValidator<null | T>

---

nullish()

nullish(options: ValidatorOptions): UnionValidator<undefined | null | T>

Defined in: projects/shapeshift/src/validators/BaseValidator.ts:40

Parameters

Parameter	Type
options	ValidatorOptions

Returns

UnionValidator<undefined | null | T>

---

optional()

optional(options: ValidatorOptions): UnionValidator<undefined | T>

Defined in: projects/shapeshift/src/validators/BaseValidator.ts:32

Parameters

Parameter	Type
options	ValidatorOptions

Returns

UnionValidator<undefined | T>

---

or()

or<O>(...predicates: readonly BaseValidator<O>[]): UnionValidator<T | O>

Defined in: projects/shapeshift/src/validators/BaseValidator.ts:52

Type Parameters

Type Parameter
O

Parameters

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

Returns

UnionValidator<T | O>

---

parse()

parse<R>(value: unknown): R

Defined in: projects/shapeshift/src/validators/BaseValidator.ts:114

Type Parameters

Type Parameter	Default type
R	T

Parameters

Parameter	Type
value	unknown

Returns

R

---

reshape()

Call Signature

reshape(cb: (input: T) => Result<T>, options?: ValidatorOptions): this

Defined in: projects/shapeshift/src/validators/BaseValidator.ts:67

Parameters

Parameter	Type
cb	(input: T) => Result<T>
options?	ValidatorOptions

Returns

this

Call Signature

reshape<R, O>(cb: (input: T) => R, options?: ValidatorOptions): BaseValidator<O>

Defined in: projects/shapeshift/src/validators/BaseValidator.ts:68

Type Parameters

Type Parameter	Default type
R extends Result<unknown, Error>	-
O	InferResultType<R>

Parameters

Parameter	Type
cb	(input: T) => R
options?	ValidatorOptions

Returns

BaseValidator<O>

---

run()

run(value: unknown): Result<T, BaseError>

Defined in: projects/shapeshift/src/validators/BaseValidator.ts:102

Parameters

Parameter	Type
value	unknown

Returns

Result<T, BaseError>

---

set()

set(options: ValidatorOptions): SetValidator<T>

Defined in: projects/shapeshift/src/validators/BaseValidator.ts:48

Parameters

Parameter	Type
options	ValidatorOptions

Returns

SetValidator<T>

---

setParent()

setParent(parent: object): this

Defined in: projects/shapeshift/src/validators/BaseValidator.ts:27

Parameters

Parameter	Type
parent	object

Returns

this

---

setValidationEnabled()

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

Defined in: projects/shapeshift/src/validators/BaseValidator.ts:133

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

---

transform()

Call Signature

transform(cb: (value: T) => T, options?: ValidatorOptions): this

Defined in: projects/shapeshift/src/validators/BaseValidator.ts:56

Parameters

Parameter	Type
cb	(value: T) => T
options?	ValidatorOptions

Returns

this

Call Signature

transform<O>(cb: (value: T) => O, options?: ValidatorOptions): BaseValidator<O>

Defined in: projects/shapeshift/src/validators/BaseValidator.ts:57

Type Parameters

Type Parameter
O

Parameters

Parameter	Type
cb	(value: T) => O
options?	ValidatorOptions

Returns

BaseValidator<O>

---

when()

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

Defined in: projects/shapeshift/src/validators/BaseValidator.ts:88

Type Parameters

Type Parameter	Default type
Key extends WhenKey	-
This extends BaseValidator<any>	BaseValidator<T>

Parameters

Parameter	Type
key	Key
options	WhenOptions<This, Key>
validatorOptions?	ValidatorOptions

Returns

this