Class Builder

Index

Constructors

Methods

any array boolean enum float integer null nullable number object optional scalar string

Constructors

constructor

new Builder(): Builder
Returns Builder

Methods

any

any(): AnySchema
Returns AnySchema
- Defined in src/schema.ts:335

array

array(
__namedParameters?: ArrayOptions,
block?: (builder: ArrayBuilder) => void,
): ArraySchema
Parameters
- __namedParameters: ArrayOptions = {}
- Optionalblock: (builder: ArrayBuilder) => void
Returns ArraySchema
- Defined in src/schema.ts:317

boolean

boolean(): ScalarSchema
Returns ScalarSchema
- Defined in src/schema.ts:374

enum

enum(...values: unknown[]): ScalarSchema
Parameters
- ...values: unknown[]
Returns ScalarSchema
- Defined in src/schema.ts:351

float

float(): ScalarSchema
Returns ScalarSchema
- Defined in src/schema.ts:366

integer

integer(): ScalarSchema
Returns ScalarSchema
- Defined in src/schema.ts:362

null

null(): ScalarSchema
Returns ScalarSchema
- Defined in src/schema.ts:378

nullable

nullable(schema: SchemaNode): NullableSchema
Parameters
- schema: SchemaNode
Returns NullableSchema
- Defined in src/schema.ts:327

number

number(): ScalarSchema
Returns ScalarSchema
- Defined in src/schema.ts:370

object

object(
__namedParameters?: { allowExtra?: boolean },
block?: (builder: ObjectBuilder) => void,
): ObjectSchema
Parameters
- __namedParameters: { allowExtra?: boolean } = {}
- Optionalblock: (builder: ObjectBuilder) => void
Returns ObjectSchema
- Defined in src/schema.ts:308

optional

optional(schema: SchemaNode): OptionalSchema
Parameters
- schema: SchemaNode
Returns OptionalSchema
- Defined in src/schema.ts:331

scalar

scalar(...types: (string | { enum: unknown[] })[]): ScalarSchema
Parameters
- ...types: (string | { enum: unknown[] })[]
Returns ScalarSchema
- Defined in src/schema.ts:339

string

string(): ScalarSchema
Returns ScalarSchema
- Defined in src/schema.ts:358