ObjectValidator

Public class

class ObjectValidator<Shape extends object> extends Validator<Shape> {}

Validator

packages/validate/src/lib/validation.ts

Constructor

Public constructor

Constructs a new instance of the ObjectValidator class

{
  readonly [K in keyof Shape]: Validatable<Shape[K]>
}

boolean

Validatable

Properties

config

Public readonly property

readonly config: {
  readonly [K in keyof Shape]: Validatable<Shape[K]>
}

Validatable

Methods

allowUnknownProperties()

Public method

allowUnknownProperties(): ObjectValidator<Shape>

ObjectValidator

extend()

Public method

Extend an object validator by adding additional properties.

const animalValidator = T.object({
  name: T.string,
})
const catValidator = animalValidator.extend({
  meowVolume: T.number,
})

extend<Extension extends Record<string, unknown>>(extension: {
  readonly [K in keyof Extension]: Validatable<Extension[K]>
}): ObjectValidator<Shape & Extension>

{
  readonly [K in keyof Extension]: Validatable<Extension[K]>
}

ObjectValidator<Shape & Extension>

Validatable, ObjectValidator