required

Creates an object schema consisting of all properties of an existing object schema set to non optional.

// Required object schema with an optional pipe
const Schema = required<TSchema>(schema, pipe);

// Required object schema with an optional message and pipe
const Schema = required<TSchema>(schema, message, pipe);

// Required object schema with rest and optional pipe
const Schema = required<TSchema, TRest>(schema, rest, pipe);

// Required object schema with rest and optional message and pipe
const Schema = required<TSchema, TRest>(schema, rest, message, pipe);

Generics

TSchema extends ObjectSchema<any, any>
TRest extends BaseSchema | undefined

Parameters

schema TSchema
rest TRest
message ErrorMessage | undefined
pipe Pipe<ObjectOutput<RequiredObjectEntries<TSchema['entries']>, TRest>> | undefined

Explanation

required creates a new object schema where the entries of the provided object schema are non optional. It is similar to TypeScript's Required utility type.

Note that rest, message and pipe of the passed schema are completely ignored and must be added again.

Returns

Schema ObjectSchema<RequiredObjectEntries<TSchema['entries']>, TRest>

Examples

The following examples show how required can be used.

Required object schema

Schema to validate an object with required entries.

const RequiredObjectSchema = required(
  object({
    key1: optional(string()),
    key2: optional(number()),
  })
);

The following APIs can be combined with required.

Schemas

Methods

Transformations

toCustom

Validations

custom