Skip to main content

Class: TupleValidator<T>

Type parameters

NameType
Textends any[]

Hierarchy

Constructors

constructor

new TupleValidator<T>(validators, constraints?)

Type parameters

NameType
Textends any[]

Parameters

NameTypeDefault value
validatorsBaseValidator<[...T[]]>[]undefined
constraintsreadonly IConstraint<[...T[]], [...T[]]>[][]

Overrides

BaseValidator.constructor

Defined in

projects/shapeshift/src/validators/TupleValidator.ts:11

Properties

constraints

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

Inherited from

BaseValidator.constraints

Defined in

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


validators

Private Readonly validators: BaseValidator<[...T[]]>[] = []

Defined in

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

Accessors

array

get array(): ArrayValidator<T>

Returns

ArrayValidator<T>

Inherited from

BaseValidator.array

Defined in

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


nullable

get nullable(): UnionValidator<null | T>

Returns

UnionValidator<null | T>

Inherited from

BaseValidator.nullable

Defined in

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


nullish

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

Returns

UnionValidator<undefined | null | T>

Inherited from

BaseValidator.nullish

Defined in

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


optional

get optional(): UnionValidator<undefined | T>

Returns

UnionValidator<undefined | T>

Inherited from

BaseValidator.optional

Defined in

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


set

get set(): SetValidator<T>

Returns

SetValidator<T>

Inherited from

BaseValidator.set

Defined in

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

Methods

addConstraint

Protected addConstraint(constraint): TupleValidator<T>

Parameters

NameType
constraintIConstraint<[...T[]], [...T[]]>

Returns

TupleValidator<T>

Inherited from

BaseValidator.addConstraint

Defined in

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


clone

Protected clone(): TupleValidator<T>

Returns

TupleValidator<T>

Overrides

BaseValidator.clone

Defined in

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


default

default(value): DefaultValidator<Exclude<[...T[]], undefined>>

Parameters

NameType
valueExclude<[...T[]], undefined> | () => Exclude<[...T[]], undefined>

Returns

DefaultValidator<Exclude<[...T[]], undefined>>

Inherited from

BaseValidator.default

Defined in

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


handle

Protected handle(values): Result<[...T[]], CombinedPropertyError | ValidationError>

Parameters

NameType
valuesunknown

Returns

Result<[...T[]], CombinedPropertyError | ValidationError>

Overrides

BaseValidator.handle

Defined in

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


or

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

Type parameters

Name
O

Parameters

NameType
...predicatesreadonly BaseValidator<O>[]

Returns

UnionValidator<[...T[]] | O>

Inherited from

BaseValidator.or

Defined in

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


parse

parse(value): [...T[]]

Parameters

NameType
valueunknown

Returns

[...T[]]

Inherited from

BaseValidator.parse

Defined in

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


run

run(value): Result<[...T[]], BaseError>

Parameters

NameType
valueunknown

Returns

Result<[...T[]], BaseError>

Inherited from

BaseValidator.run

Defined in

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


transform

transform(cb): TupleValidator<T>

Parameters

NameType
cb(value: [...T[]]) => [...T[]]

Returns

TupleValidator<T>

Inherited from

BaseValidator.transform

Defined in

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

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

Type parameters

Name
O

Parameters

NameType
cb(value: [...T[]]) => O

Returns

BaseValidator<O>

Inherited from

BaseValidator.transform

Defined in

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