Class ObjectSchema<T>

Chainable object validators.

Type Parameters

T extends object

Hierarchy (view full)

ValueSchema<T>
- ObjectSchema

Implements

ValidatorWithPartial<T, unknown>

Index

Constructors

constructor

new ObjectSchema<T>(currentValidator): ObjectSchema<T>
Constructs the first link in a schema chain.
Type Parameters
- T extends object
Parameters
- currentValidator: Validator<any, any>
Returns ObjectSchema<T>
Inherited from ValueSchema.constructor
- Defined in util/validation/SchemaBase.ts:31
new ObjectSchema<T>(currentValidator, previousSchema, operation): ObjectSchema<T>
Constructs linking to the given previous schema.
Type Parameters
- T extends object
Parameters
- currentValidator: Validator<any, any>
- previousSchema: SchemaBase<any>
- operation: ((validatorA: Validator<any, unknown>, validatorB: Validator<any, any>) => Validator<T, unknown>)
  - - (validatorA, validatorB): Validator<T, unknown>
    - Parameters
      validatorA: Validator<any, unknown>
      validatorB: Validator<any, any>
      Returns Validator<T, unknown>
Returns ObjectSchema<T>
Inherited from ValueSchema.constructor
- Defined in util/validation/SchemaBase.ts:40

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.

`Protected` `Readonly`currentValidator

currentValidator: ValidatorWithPartial<T, any>

`Protected` `Optional` `Readonly`operation

operation?: ((validatorA: Validator<any, unknown>, validatorB: Validator<any, any>) => Validator<T, unknown>)

`Protected` `Optional` `Readonly`previousSchema

previousSchema?: SchemaBase<any>

`Static` `Readonly`base

base: ObjectSchema<object> = ...

Accessors

description

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

Returns string
Implementation of ValidatorWithPartial.description
Inherited from ValueSchema.description
- Defined in util/validation/SchemaBase.ts:63

Methods

and

and<U>(nextValidator): ValueSchema<T & U>
Returns a validator that asserts if this validator and the next passes.
Type Parameters
- U
Parameters
- nextValidator: Validator<U, any>
  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 util/validation/ValueSchema.ts:75

assert

assert(input, origin?, path?): 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.
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
Implementation of ValidatorWithPartial.assert
Inherited from ValueSchema.assert
- Defined in util/validation/SchemaBase.ts:67

cast

cast<T>(): ObjectSchema<T>
Casts the type parameter.
Type Parameters
- T extends object
Returns ObjectSchema<T>
- Defined in util/validation/ObjectSchema.ts:141

`Protected`chain

chain(nextValidator): 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 util/validation/SchemaBase.ts:141

`Protected`clone

clone(transform): any
Clones this schema, transforming all validators with the given mutator.
Parameters
- transform: ((validator: Validator<any, unknown>) => Validator<any, unknown>)
  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.
  - - (validator): Validator<any, unknown>
    - Parameters
      validator: Validator<any, unknown>
      Returns Validator<any, unknown>
Returns any
Inherited from ValueSchema.clone
- Defined in util/validation/SchemaBase.ts:94

deepPartial

deepPartial(): ObjectSchema<DeepPartial<T>>
Allows all recursive properties to be undefined.

Returns ObjectSchema<DeepPartial<T>>
Implementation of ValidatorWithPartial.deepPartial
- Defined in util/validation/ObjectSchema.ts:134

isValid

isValid(input): input is T
Returns true if the input is valid according to this validator.
Parameters
- input: unknown
Returns input is T
Implementation of ValidatorWithPartial.isValid
Inherited from ValueSchema.isValid
- Defined in util/validation/SchemaBase.ts:75

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 util/validation/ValueSchema.ts:49

or

or<U>(nextValidator): 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 util/validation/ValueSchema.ts:89

orNull

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

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

orUndefined

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

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

partial

partial(): ObjectSchema<Partial<T>>
Allows all properties to be undefined.

Returns ObjectSchema<Partial<T>>
Implementation of ValidatorWithPartial.partial
- Defined in util/validation/ObjectSchema.ts:127

`Protected`self

self(current): any
Parameters
- current: Validator<any, any>
Returns any
Inherited from ValueSchema.self
- Defined in util/validation/SchemaBase.ts:106
self(currentValidator, previousSchema, operation): any
Parameters
- currentValidator: Validator<any, any>
- previousSchema: SchemaBase<any>
- operation: ((validatorA: Validator<any, unknown>, validatorB: Validator<any, any>) => Validator<T, unknown>)
  - - (validatorA, validatorB): Validator<T, unknown>
    - Parameters
      validatorA: Validator<any, unknown>
      validatorB: Validator<any, any>
      Returns Validator<T, unknown>
Returns any
Inherited from ValueSchema.self
- Defined in util/validation/SchemaBase.ts:108

validate

validate(input, options?, path?): readonly ValidationErrorMessage[]
Validates the provided input, returning a list of error messages, or an empty array if the input passes this validator.
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.
Implementation of ValidatorWithPartial.validate
Inherited from ValueSchema.validate
- Defined in util/validation/SchemaBase.ts:79

withProps

withProps<U>(propertyValidators): ObjectSchema<T & U>
Creates a validator that validates the input has properties that pass their respective validators.
Type Parameters
- U extends object
Parameters
- propertyValidators: {
  readonly [P in string | number | symbol]-?: Validator<U[P], unknown>
  }
Returns ObjectSchema<T & U>
- Defined in util/validation/ObjectSchema.ts:118

Class ObjectSchema<T>

Type Parameters

Hierarchy (view full)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns ObjectSchema<T>

Type Parameters

Parameters

Parameters

Returns Validator<T, unknown>

Returns ObjectSchema<T>

Properties

__type

Protected ReadonlycurrentValidator

Protected Optional Readonlyoperation

Protected Optional ReadonlypreviousSchema

Static Readonlybase

Accessors

description

Returns string

Methods

and

Type Parameters

Parameters

Returns ValueSchema<T & U>

See

assert

Parameters

Returns asserts input is T

cast

Type Parameters

Returns ObjectSchema<T>

Protectedchain

Parameters

Returns any

Protectedclone

Parameters

Parameters

Returns Validator<any, unknown>

Returns any

deepPartial

Returns ObjectSchema<DeepPartial<T>>

isValid

Parameters

Returns input is T

maybe

Returns ValueSchema<undefined | null | T>

or

Type Parameters

Parameters

Returns ValueSchema<T | U>

orNull

Returns ValueSchema<null | T>

orUndefined

Returns ValueSchema<undefined | T>

partial

Returns ObjectSchema<Partial<T>>

Protectedself

Parameters

Returns any

Parameters

Parameters

Returns Validator<T, unknown>

Returns any

validate

Parameters

Returns readonly ValidationErrorMessage[]

withProps

Type Parameters

Parameters

Returns ObjectSchema<T & U>

Settings

`Protected` `Readonly`currentValidator

`Protected` `Optional` `Readonly`operation

`Protected` `Optional` `Readonly`previousSchema

`Static` `Readonly`base

`Protected`chain

`Protected`clone

`Protected`self