merge

Merges the entries of multiple object schemas. Subsequent object entries overwrite the previous ones.

// Object schema with an optional pipe
const Schema = merge<TSchemas>(schemas, pipe);

// Object schema with an optional message and pipe
const Schema = merge<TSchemas>(schemas, message, pipe);

// Object schema with rest and optional pipe
const Schema = merge<TSchemas, TRest>(schemas, rest, pipe);

// Object schema with rest and optional message and pipe
const Schema = merge<TSchemas, TRest>(schemas, rest, message, pipe);

Generics

• TSchemas extends ObjectSchemas
• TRest extends BaseSchema | undefined

Parameters

• schemas TSchema
• rest TRest
• message ErrorMessage | undefined
• pipe Pipe<ObjectOutput<MergeObjects<TSchemas>, TRest>> | undefined

Explanation

merge creates a new object schema where the entries of the provided object schemas are merged.

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

Returns

• Schema ObjectSchema<MergeObjects<TSchemas>, TRest>

Examples

The following examples show how merge can be used.

Merged object schema

Schema that contains the merged entries of two object schemas.

Note that the baz entry of the second object schema overwrites the baz entry of the first object schema.

const MergedObjectSchema = merge([
  object({ foo: string(), baz: number() }),
  object({ bar: string(), baz: boolean() }),
]); // { foo: string; bar: string; baz: boolean }

Related

The following APIs can be combined with merge.

Schemas

• any,
• array,
• bigint,
• blob,
• boolean,
• date,
• enum_,
• instance,
• intersect,
• lazy,
• literal,
• map,
• nan,
• never,
• nonNullable,
• nonNullish,
• nonOptional,
• null_,
• nullable,
• nullish,
• number,
• object,
• optional,
• picklist,
• record,
• set,
• special,
• string,
• symbol,
• tuple,
• undefined_,
• union,
• unknown,
• variant,
• void_

Methods

• brand,
• coerce,
• fallback,
• forward,
• getDefault,
• getDefaults,
• getFallback,
• getFallbacks,
• is,
• keyof,
• omit,
• parse,
• partial,
• pick,
• required,
• safeParse,
• transform,
• unwrap

Transformations

• toCustom

Validations

• custom