Function: merge()

Call Signature

declare function merge<A extends Args, B extends Args>(a: A, b: B): Omit<A, keyof B> & B

WARNING

This API is experimental and may change in future versions.

Compose multiple Args schemas into one.

On key conflicts the later schema wins (last-write-wins).

Type Parameters

Name	Description
A extends Args	First schema type.
B extends Args	Second schema type.

Parameters

Name	Type	Description
a	A	First schema.
b	B	Second schema.

Returns

Omit<A, keyof B> & B — A merged schema containing all fields.

Examples

const common = args({ verbose: boolean() })
const network = args({ host: required(string()), port: withDefault(integer(), 8080) })
const schema = merge(common, network)

Call Signature

declare function merge<A extends Args, B extends Args, C extends Args>(a: A, b: B, c: C): Omit<Omit<A, keyof B | keyof C> & Omit<B, keyof C>, never> & C

WARNING

This API is experimental and may change in future versions.

Compose multiple Args schemas into one.

Type Parameters

Name
A extends Args
B extends Args
C extends Args

Parameters

Name	Type	Description
a	A	First schema.
b	B	Second schema.
c	C	Third schema.

Returns

Omit<Omit<A, keyof B | keyof C> & Omit<B, keyof C>, never> & C — A merged schema containing all fields.

Call Signature

declare function merge<A extends Args, B extends Args, C extends Args, D extends Args>(a: A, b: B, c: C, d: D): MergeArgs<[A, B, C, D]>

WARNING

This API is experimental and may change in future versions.

Compose multiple Args schemas into one.

Type Parameters

Name
A extends Args
B extends Args
C extends Args
D extends Args

Parameters

Name	Type	Description
a	A	First schema.
b	B	Second schema.
c	C	Third schema.
d	D	Fourth schema.

Returns

MergeArgs<[A, B, C, D]> — A merged schema containing all fields.

Call Signature

declare function merge<T extends Args[]>(...schemas: T): MergeArgs<T>

WARNING

This API is experimental and may change in future versions.

Compose multiple Args schemas into one.

Type Parameters

Name
T extends Args[]

Parameters

Name	Type	Description
schemas	T	The schemas to merge.

Returns

MergeArgs<T> — A merged schema containing all fields.