Class ArraySchema<T>

A base class for validation state. Provides methods for chaining.

Subclasses should not override constructors.

Type Parameters

T extends readonly unknown[]

Hierarchy (View Summary)

ValueSchema<T>
- ArraySchema

Index

Constructors

constructor

new ArraySchema<T extends readonly unknown[]>(
currentValidator: Validator<any, any>,
): ArraySchema<T>
Constructs the first link in a schema chain.
Type Parameters
- T extends readonly unknown[]
Parameters
- currentValidator: Validator<any, any>
Returns ArraySchema<T>
Inherited from ValueSchema.constructor
- Defined in SchemaBase.ts:45
new ArraySchema<T extends readonly unknown[]>(
 currentValidator: Validator<any, any>,
 previousSchema: SchemaBase<any>,
 operation: (
 validatorA: Validator<any>,
 validatorB: Validator<any, any>,
 ) => Validator<T>,
): ArraySchema<T>
Constructs linking to the given previous schema.
Type Parameters
- T extends readonly unknown[]
Parameters
- currentValidator: Validator<any, any>
- previousSchema: SchemaBase<any>
- operation: (validatorA: Validator<any>, validatorB: Validator<any, any>) => Validator<T>
Returns ArraySchema<T>
Inherited from ValueSchema.constructor
- Defined in SchemaBase.ts:54

Properties

__type

__type: Invariant<T> = ...

Enforces T is in an invariant position. This prevents a validator with more strict rules is assigned to a less strict type, which can cause unexpected validation errors.

`Readonly`assert

assert: (
    input: unknown,
    origin?: string,
    path?: readonly string[],
) => asserts input is T = ...

Validates the given input, asserting that the input is type T. If the input is not valid, a ValidationError will be thrown.

Type declaration

- (input: unknown, origin?: string, path?: readonly string[]): asserts input is T
- Parameters
  - input: unknown
    The input to validate.
  - Optionalorigin: string
    The error origin. ErrorOrigin.API by default.
  - Optionalpath: readonly string[]
    The current field path to this validator.
  Returns asserts input is T
  Returns the input, cast as the validated type T

`Readonly`isValid

isValid: (input: unknown) => input is T = ...

Returns true if the input is valid according to this validator.

Accessors

description

get description(): string
A short description of the validator.

Returns string
Inherited from ValueSchema.description
- Defined in SchemaBase.ts:79

options

get options(): { optional: false }
Returns { optional: false }
Inherited from ValueSchema.options
- Defined in SchemaBase.ts:36

`Static`base

get base(): ArraySchema<unknown[]>
The base ArraySchema instance validating that the input is an Array.

Returns ArraySchema<unknown[]>
- Defined in ArraySchema.ts:144

Methods

and

and(nextValidator: Validator): ValueSchema<T & U>
Returns a validator that asserts if this validator and the next passes.
Type Parameters
- U
Parameters
- nextValidator: Validator
 The validator to run after the current.
Returns ValueSchema<T & U>
Returns a new ValueSchema intersecting this validator and the next.

See
andValidators
Inherited from ValueSchema.and
- Defined in ValueSchema.ts:75

cast

cast<T extends readonly unknown[]>(): ArraySchema<T>
Casts the type parameter.
Type Parameters
- T extends readonly unknown[]
Returns ArraySchema<T>
- Defined in ArraySchema.ts:205

`Protected`chain

chain(nextValidator: Validator<any, any>): any
Constructs a new schema with a validator chaining the current validator with the provided next in an AND operation.
Parameters
- nextValidator: Validator<any, any>
 The validator to run after the current.
Returns any
Returns a new Schema instance the same class with a new validator chaining the current validator with the given next in an AND operation.
Inherited from ValueSchema.chain
- Defined in SchemaBase.ts:160

`Protected`clone

clone(transform?: (validator: Validator<any>) => Validator<any>): any
Clones this schema, transforming all validators with the given mutator.
Parameters
- transform: (validator: Validator<any>) => Validator<any> = ...
 A transformer which takes an existing validator in the chain and returns a new one. Validators should be considered to be immutable; transform should not change the input but instead return a new validator.
Returns any
Inherited from ValueSchema.clone
- Defined in SchemaBase.ts:109

maxLength

maxLength(max: number): ArraySchema<T>
Creates a validator that validates the input array has the given maximum length.
Parameters
- max: number
 The maximum number of elements (inclusive)
Returns ArraySchema<T>
- Defined in ArraySchema.ts:190

maybe

maybe(): ValueSchema<undefined | null | T>
Prepends this validator allowing for null or undefined.

Returns ValueSchema<undefined | null | T>
Inherited from ValueSchema.maybe
- Defined in ValueSchema.ts:49

minLength

minLength(min: number): ArraySchema<T>
Creates a validator that validates the input array has the given minimum length.
Parameters
- min: number
 The minimum number of elements (inclusive)
Returns ArraySchema<T>
- Defined in ArraySchema.ts:181

optional

optional(): PropertyValidatorWithOptions<ArraySchema<T>, T, { optional: true }>
Returns PropertyValidatorWithOptions<ArraySchema<T>, T, { optional: true }>
Inherited from ValueSchema.optional
- Defined in SchemaBase.ts:164

or

or(nextValidator: Validator<U, any>): ValueSchema<T | U>
Returns a validator that asserts if this validator or the next passes.

Implementation note: subclasses should not change the schema instance returned unless all chainable validators accept input type 'unknown'.
Type Parameters
- U
Parameters
- nextValidator: Validator<U, any>
 The validator to run after the current.
Returns ValueSchema<T | U>
Returns a new ValueSchema providing the union of this validator and the next.
Inherited from ValueSchema.or
- Defined in ValueSchema.ts:89

orNull

orNull(): ValueSchema<null | T>
Prepends this validator allowing for null.

Returns ValueSchema<null | T>
Inherited from ValueSchema.orNull
- Defined in ValueSchema.ts:56

orUndefined

orUndefined(): ValueSchema<undefined | T>
Prepends this validator allowing for undefined.

Returns ValueSchema<undefined | T>
Inherited from ValueSchema.orUndefined
- Defined in ValueSchema.ts:63

readonly

readonly(): ArraySchema<Readonly<T>>
Casts to a readonly array. This is a shallow cast, elements of the array will not be changed.

Returns ArraySchema<Readonly<T>>
- Defined in ArraySchema.ts:198

required

required(): PropertyValidatorWithOptions<ArraySchema<T>, T, { optional: false }>
Returns PropertyValidatorWithOptions<ArraySchema<T>, T, { optional: false }>
Inherited from ValueSchema.required
- Defined in SchemaBase.ts:177

`Protected`self

self(current: Validator<any, any>): any
Parameters
- current: Validator<any, any>
Returns any
Inherited from ValueSchema.self
- Defined in SchemaBase.ts:123
self(
 currentValidator: Validator<any, any>,
 previousSchema: undefined | SchemaBase<any>,
 operation:
 | undefined
 | (
 (
 validatorA: Validator<any>,
 validatorB: Validator<any, any>,
 ) => Validator<T>
 ),
): any
Parameters
- currentValidator: Validator<any, any>
- previousSchema: undefined | SchemaBase<any>
- operation:
 | undefined
 | (
 (
 validatorA: Validator<any>,
 validatorB: Validator<any, any>,
 ) => Validator<T>
 )
Returns any
Inherited from ValueSchema.self
- Defined in SchemaBase.ts:125

tuple

tuple(
 ...validators: {
 [Index in string | number | symbol]: Validator<
 U[Index<Index>],
 unknown,
 >
 },
): ArraySchema<{ [Index in string | number | symbol]: U[Index<Index>] }>
Creates a validator that asserts that the input array is a tuple whose elements match the given validators.
Type Parameters
- U extends readonly any[]
Parameters
- ...validators: { [Index in string | number | symbol]: Validator<U[Index<Index>], unknown> }
Returns ArraySchema<{ [Index in string | number | symbol]: U[Index<Index>] }>
- Defined in ArraySchema.ts:167

`Readonly`validate

validate(
    input: unknown,
    options?: ValidationOptions,
    path?: readonly string[],
): readonly ValidationErrorMessage[]
Parameters
- input: unknown
  The input to validate.
- Optionaloptions: ValidationOptions
  Validation options.
- Optionalpath: readonly string[]
  The current field path to this validator.
Returns readonly ValidationErrorMessage[]
Returns an array of validation failures. If options.all is not true, only the first error will be returned.
Inherited from ValueSchema.validate
- Defined in SchemaBase.ts:95

withElements

withElements(
elementValidator: Validator,
): ArraySchema<(ElementType<T> & U)[]>
Creates a validator that asserts that every element passes the given validator.
Type Parameters
- U
Parameters
- elementValidator: Validator
Returns ArraySchema<(ElementType<T> & U)[]>
- Defined in ArraySchema.ts:155

Class ArraySchema<T>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns ArraySchema<T>

Type Parameters

Parameters

Returns ArraySchema<T>

Properties

__type

Readonlyassert

Type declaration

Parameters

Returns asserts input is T

ReadonlyisValid

Accessors

description

Returns string

options

Returns { optional: false }

Staticbase

Returns ArraySchema<unknown[]>

Methods

and

Type Parameters

Parameters

Returns ValueSchema<T & U>

See

cast

Type Parameters

Returns ArraySchema<T>

Protectedchain

Parameters

Returns any

Protectedclone

Parameters

Returns any

maxLength

Parameters

Returns ArraySchema<T>

maybe

Returns ValueSchema<undefined | null | T>

minLength

Parameters

Returns ArraySchema<T>

optional

Returns PropertyValidatorWithOptions<ArraySchema<T>, T, { optional: true }>

or

Type Parameters

Parameters

Returns ValueSchema<T | U>

orNull

Returns ValueSchema<null | T>

orUndefined

Returns ValueSchema<undefined | T>

readonly

Returns ArraySchema<Readonly<T>>

required

Returns PropertyValidatorWithOptions<ArraySchema<T>, T, { optional: false }>

Protectedself

Parameters

Returns any

Parameters

Returns any

tuple

Type Parameters

Parameters

Returns ArraySchema<{ [Index in string | number | symbol]: U[Index<Index>] }>

Readonlyvalidate

Parameters

Returns readonly ValidationErrorMessage[]

withElements

`Readonly`assert

`Readonly`isValid

`Static`base

`Protected`chain

`Protected`clone

`Protected`self

`Readonly`validate