Class: BaseValidator<T>

Type parameters

Name
T

Hierarchy

• BaseValidator

  ↳ ArrayValidator

  ↳ BigIntValidator

  ↳ BooleanValidator

  ↳ DateValidator

  ↳ DefaultValidator

  ↳ InstanceValidator

  ↳ LiteralValidator

  ↳ MapValidator

  ↳ NativeEnumValidator

  ↳ NeverValidator

  ↳ NullishValidator

  ↳ NumberValidator

  ↳ ObjectValidator

  ↳ PassthroughValidator

  ↳ RecordValidator

  ↳ SetValidator

  ↳ StringValidator

  ↳ TupleValidator

  ↳ TypedArrayValidator

  ↳ UnionValidator

Constructors

constructor

• new BaseValidator<T>(constraints?): BaseValidator<T>

Type parameters

Name
T

Parameters

Name	Type	Default value
constraints	readonly IConstraint<T, T>[]	[]

Returns

BaseValidator<T>

Defined in

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

Properties

constraints

• Protected constraints: readonly IConstraint<T, T>[] = []

Defined in

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

---

description

• Optional description: string

Defined in

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

---

isValidationEnabled

• Protected isValidationEnabled: null | boolean | () => boolean = null

Defined in

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

---

parent

• Protected Optional parent: object

Defined in

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

Accessors

array

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

Returns

ArrayValidator<T[], T>

Defined in

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

---

nullable

• get nullable(): UnionValidator<null | T>

Returns

UnionValidator<null | T>

Defined in

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

---

nullish

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

Returns

UnionValidator<undefined | null | T>

Defined in

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

---

optional

• get optional(): UnionValidator<undefined | T>

Returns

UnionValidator<undefined | T>

Defined in

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

---

set

• get set(): SetValidator<T>

Returns

SetValidator<T>

Defined in

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

---

shouldRunConstraints

• get shouldRunConstraints(): boolean

Returns

boolean

Defined in

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

Methods

addConstraint

▸ addConstraint(constraint): this

Parameters

Name	Type
constraint	IConstraint<T, T>

Returns

this

Defined in

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

---

clone

▸ clone(): this

Returns

this

Defined in

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

---

default

▸ default(value): DefaultValidator<Exclude<T, undefined>>

Parameters

Name	Type
value	Exclude<T, undefined> | () => Exclude<T, undefined>

Returns

DefaultValidator<Exclude<T, undefined>>

Defined in

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

---

describe

▸ describe(description): this

Parameters

Name	Type
description	string

Returns

this

Defined in

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

---

getValidationEnabled

▸ getValidationEnabled(): null | boolean

Returns

null | boolean

Defined in

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

---

handle

▸ handle(value): Result<T, ValidatorError>

Parameters

Name	Type
value	unknown

Returns

Result<T, ValidatorError>

Defined in

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

---

is

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

Type parameters

Name	Type
R	T

Parameters

Name	Type
value	unknown

Returns

value is R

Defined in

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

---

or

▸ or<O>(...predicates): UnionValidator<T | O>

Type parameters

Name
O

Parameters

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

Returns

UnionValidator<T | O>

Defined in

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

---

parse

▸ parse<R>(value): R

Type parameters

Name	Type
R	T

Parameters

Name	Type
value	unknown

Returns

R

Defined in

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

---

reshape

▸ reshape(cb): this

Parameters

Name	Type
cb	(input: T) => Result<T, Error>

Returns

this

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: T) => R

Returns

BaseValidator<O>

Defined in

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

---

run

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

Parameters

Name	Type
value	unknown

Returns

Result<T, BaseError>

Defined in

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

---

setParent

▸ setParent(parent): this

Parameters

Name	Type
parent	object

Returns

this

Defined in

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

---

setValidationEnabled

▸ setValidationEnabled(isValidationEnabled): this

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

this

Defined in

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

---

transform

▸ transform(cb): this

Parameters

Name	Type
cb	(value: T) => T

Returns

this

Defined in

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

▸ transform<O>(cb): BaseValidator<O>

Type parameters

Name
O

Parameters

Name	Type
cb	(value: T) => O

Returns

BaseValidator<O>

Defined in

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

---

when

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

Type parameters

Name	Type
Key	extends WhenKey
This	extends BaseValidator<any> = BaseValidator<T>

Parameters

Name	Type
key	Key
options	WhenOptions<This, Key>

Returns

this

Defined in

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