Class RecordSchema<T>

Chainable object validators for the Record type.

Type Parameters

T extends ReadonlyRecord<keyof any, any>

Hierarchy (View Summary)

ValueSchema<T>
- RecordSchema

Index

Constructors

constructor

new RecordSchema<T extends ReadonlyRecord<string | number | symbol, any>>(
currentValidator: Validator<any, any>,
): RecordSchema<T>
Constructs the first link in a schema chain.
Type Parameters
- T extends ReadonlyRecord<string | number | symbol, any>
Parameters
- currentValidator: Validator<any, any>
Returns RecordSchema<T>
Inherited from ValueSchema.constructor
- Defined in SchemaBase.ts:45
new RecordSchema<T extends ReadonlyRecord<string | number | symbol, any>>(
    currentValidator: Validator<any, any>,
    previousSchema: SchemaBase<any>,
    operation: (
        validatorA: Validator<any>,
        validatorB: Validator<any, any>,
    ) => Validator<T>,
): RecordSchema<T>
Constructs linking to the given previous schema.
Type Parameters
- T extends ReadonlyRecord<string | number | symbol, any>
Parameters
- currentValidator: Validator<any, any>
- previousSchema: SchemaBase<any>
- operation: (validatorA: Validator<any>, validatorB: Validator<any, any>) => Validator<T>
Returns RecordSchema<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(): RecordSchema<Record<string | number | symbol, unknown>>
The base Object validator validating that the input is an object.

Returns RecordSchema<Record<string | number | symbol, unknown>>
- Defined in RecordSchema.ts:81

Methods

and

and<U>(nextValidator: Validator<U>): ValueSchema<T & U>
Returns a validator that asserts if this validator and the next passes.
Type Parameters
- U
Parameters
- nextValidator: Validator<U>
  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 ReadonlyRecord<string | number | symbol, unknown>>(): RecordSchema<
T,
>
Casts the type parameter.
Type Parameters
- T extends ReadonlyRecord<string | number | symbol, unknown>
Returns RecordSchema<T>
- Defined in RecordSchema.ts:135

`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

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

optional

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

or

or<U>(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(): RecordSchema<T extends Record<K, V> ? ReadonlyRecord<K, V> : never>
Casts to a ReadonlyRecord

Returns RecordSchema<T extends Record<K, V> ? ReadonlyRecord<K, V> : never>
- Defined in RecordSchema.ts:126

record

record<K extends string | symbol, V>(
keyValidator: Validator<K>,
valueValidator: Validator<V>,
): RecordSchema<ReadonlyRecord<K, V>>
Returns a validator that asserts that the object's own enumerable properties has keys and values that match their respective validators.

Prototype members are not included. Numeric keys are validated as strings. For example the object { [0]: 1 } will be passed to the key validator as '0'.
Type Parameters
- K extends string | symbol
- V
Parameters
- keyValidator: Validator<K>
  Validates each key.
- valueValidator: Validator<V>
  Validates each value.
Returns RecordSchema<ReadonlyRecord<K, V>>
- Defined in RecordSchema.ts:102

recordValues

recordValues<V>(valueValidator: Validator<V>): RecordSchema<Record<string, V>>
Returns a validator that asserts that the object's own enumerable properties has string keys and values that match the given validator.

Prototype members are not included.
Type Parameters
- V
Parameters
- valueValidator: Validator<V>
  Validates each value.
Returns RecordSchema<Record<string, V>>
- Defined in RecordSchema.ts:117

required

required(): PropertyValidatorWithOptions<
    RecordSchema<T>,
    T,
    { optional: false },
>
Returns PropertyValidatorWithOptions<RecordSchema<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

`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

Class RecordSchema<T>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns RecordSchema<T>

Type Parameters

Parameters

Returns RecordSchema<T>

Properties

__type

Readonlyassert

Type declaration

Parameters

Returns asserts input is T

ReadonlyisValid

Accessors

description

Returns string

options

Returns { optional: false }

Staticbase

Returns RecordSchema<Record<string | number | symbol, unknown>>

Methods

and

Type Parameters

Parameters

Returns ValueSchema<T & U>

See

cast

Type Parameters

Returns RecordSchema<T>

Protectedchain

Parameters

Returns any

Protectedclone

Parameters

Returns any

maybe

Returns ValueSchema<undefined | null | T>

optional

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

or

Type Parameters

Parameters

Returns ValueSchema<T | U>

orNull

Returns ValueSchema<null | T>

orUndefined

Returns ValueSchema<undefined | T>

readonly

Returns RecordSchema<T extends Record<K, V> ? ReadonlyRecord<K, V> : never>

record

Type Parameters

Parameters

Returns RecordSchema<ReadonlyRecord<K, V>>

recordValues

Type Parameters

Parameters

Returns RecordSchema<Record<string, V>>

required

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

Protectedself

Parameters

Returns any

Parameters

Returns any

Readonlyvalidate

Parameters

Returns readonly ValidationErrorMessage[]

Settings

On This Page

`Readonly`assert

`Readonly`isValid

`Static`base

`Protected`chain

`Protected`clone

`Protected`self

`Readonly`validate