Class ValueSchema<T>

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

Subclasses should not override constructors.

Type Parameters

Hierarchy (View Summary)

SchemaBase<T>
- ValueSchema

Index

Constructors

constructor

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

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 SchemaBase.description
- Defined in SchemaBase.ts:85

jsonSchema

get jsonSchema(): JsonSchema | undefined
The composed JSON Schema fragment for this schema, including any describe description. Composes through chaining the same way description does; serialize a complete definition with toJsonSchema.

Returns JsonSchema | undefined
Inherited from SchemaBase.jsonSchema
- Defined in SchemaBase.ts:94

options

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

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
- Defined in ValueSchema.ts:91

`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 SchemaBase.chain
- Defined in SchemaBase.ts:202

`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 SchemaBase.clone
- Defined in SchemaBase.ts:150

describe

describe(description: string): this
Attaches a human-readable description to this schema, akin to zod's describe. The description is metadata only; it does not affect validation, and surfaces in the output of toJsonSchema.
Parameters
- description: string
  The description to attach.
Returns this
A clone of this schema carrying the description.
Inherited from SchemaBase.describe
- Defined in SchemaBase.ts:110

maybe

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

Returns ValueSchema<T | null | undefined>
- Defined in ValueSchema.ts:65

optional

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

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.
- Defined in ValueSchema.ts:105

orNull

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

Returns ValueSchema<T | null>
- Defined in ValueSchema.ts:72

orUndefined

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

Returns ValueSchema<T | undefined>
- Defined in ValueSchema.ts:79

required

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

`Protected`self

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

toJsonSchema

toJsonSchema(): JsonSchema
Serializes this schema to a JSON Schema definition, suitable for describing the shape to an LLM or other consumer. Works similarly to zod-to-json-schema.

Returns JsonSchema
Inherited from SchemaBase.toJsonSchema
- Defined in SchemaBase.ts:120

`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 SchemaBase.validate
- Defined in SchemaBase.ts:136

Class ValueSchema<T>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns ValueSchema<T>

Type Parameters

Parameters

Returns ValueSchema<T>

Properties

__type

Readonlyassert

Type Declaration

Parameters

Returns asserts input is T

ReadonlyisValid

Accessors

description

Returns string

jsonSchema

Returns JsonSchema | undefined

options

Returns { optional: false }

Methods

and

Type Parameters

Parameters

Returns ValueSchema<T & U>

See

Protectedchain

Parameters

Returns any

Protectedclone

Parameters

Returns any

describe

Parameters

Returns this

maybe

Returns ValueSchema<T | null | undefined>

optional

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

or

Type Parameters

Parameters

Returns ValueSchema<T | U>

orNull

Returns ValueSchema<T | null>

orUndefined

Returns ValueSchema<T | undefined>

required

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

Protectedself

Parameters

Returns any

Parameters

Returns any

toJsonSchema

Returns JsonSchema

Readonlyvalidate

Parameters

Returns readonly ValidationErrorMessage[]

Settings

On This Page

`Readonly`assert

`Readonly`isValid

`Protected`chain

`Protected`clone

`Protected`self

`Readonly`validate