partial

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

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

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

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

// Partial object schema with rest and optional message and pipe
const Schema = partial<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<PartialObjectEntries<TSchema['entries']>, TRest>> | undefined

Explanation

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

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

Returns

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

Examples

The following examples show how partial can be used.

Partial object schema

Schema to validate an object with partial entries.

const PartialObjectSchema = partial(
  object({
    key1: string(),
    key2: number(),
  })
);

The following APIs can be combined with partial.

Schemas

Methods

Transformations

toCustom

Validations

custom