Class ObjectBuilder<P>

Fluent object schema builder that produces Schema instances.

Type Parameters

P extends PropsRecord

Index

Constructors

Methods

allowUnknown asSchema build property

Constructors

constructor

new ObjectBuilder<P extends PropsRecord>(
name: undefined | string,
props: P,
): ObjectBuilder<P>
Type Parameters
- P extends PropsRecord
Parameters
- name: undefined | string
- props: P
Returns ObjectBuilder<P>
- Defined in tmp/package/dist/index.d.ts:3155

Methods

allowUnknown

allowUnknown(): this
Permits keys not explicitly defined in the builder.

Returns this
The current builder with unknown-key support enabled.
- Defined in tmp/package/dist/index.d.ts:3175

asSchema

asSchema(): Schema<InferProps<P>>
Convenience wrapper that returns the built schema directly.

Returns Schema<InferProps<P>>
A schema equivalent to the result of build.
- Defined in tmp/package/dist/index.d.ts:3187

build

build(): ObjectSchema<P, InferProps<P>>
Finalises and freezes the builder into an object schema.

Returns ObjectSchema<P, InferProps<P>>
An immutable schema that validates the configured shape.
- Defined in tmp/package/dist/index.d.ts:3181

property

property<K extends string, S extends Schema<any>>(
key: K,
schema: S,
): ObjectBuilder<P & { [Q in string]: { schema: S } }>
Adds a property schema to the current builder.
Type Parameters
- K extends string
  Property name being added.
- S extends Schema<any>
  Schema that validates the property.
Parameters
- key: K
  Object key to associate with the schema.
- schema: S
  Schema that validates the property value.
Returns ObjectBuilder<P & { [Q in string]: { schema: S } }>
The builder with an updated type signature.
- Defined in tmp/package/dist/index.d.ts:3165