Function mergeDeep

Recursively copies the values of all the enumerable own properties from one or two source objects to a new object. Arrays will be concatenated.

Param: sources

One or more source objects from which to copy properties. A single source provided will return a deep clone. Incompatible objects, for example given a number and an array, will return a clone of the last argument.

Param: options

See

merge

mergeDeep<T extends any[]>(
sources: readonly T[],
options?: Partial<MergeOptions>,
): T
Concatenates multiple arrays together where each element is deeply cloned.
Type Parameters
- T extends any[]
Parameters
- sources: readonly T[]
- Optionaloptions: Partial<MergeOptions>
Returns T
- Defined in util/object/mergeDeep.ts:22
mergeDeep<T>(sources: readonly [T], options?: Partial<MergeOptions>): T
Deep clones the given object.
Type Parameters
- T
Parameters
- sources: readonly [T]
- Optionaloptions: Partial<MergeOptions>
Returns T
- Defined in util/object/mergeDeep.ts:30
mergeDeep<A, B>(
sources: readonly [A, B],
options?: Partial<MergeOptions>,
): A & B
Deep merges the two objects. If common keys are both arrays, they will be concatenated, if common keys are both objects, they will be merged. Incompatible types, e.g. an object and an array will use the later source.
Type Parameters
- A
- B
Parameters
- sources: readonly [A, B]
- Optionaloptions: Partial<MergeOptions>
Returns A & B
- Defined in util/object/mergeDeep.ts:40
mergeDeep<A, B, C>(
sources: readonly [A, B, C],
options?: Partial<MergeOptions>,
): A & B & C
Deep merges the three objects. If common keys are both arrays, they will be concatenated, if common keys are both objects, they will be merged. Incompatible types, e.g. an object and an array will use the later source.
Type Parameters
- A
- B
- C
Parameters
- sources: readonly [A, B, C]
- Optionaloptions: Partial<MergeOptions>
Returns A & B & C
- Defined in util/object/mergeDeep.ts:50
mergeDeep<A, B, C, D>(
sources: readonly [A, B, C, D],
options?: Partial<MergeOptions>,
): A & B & C & D
Deep merges the four objects. If common keys are both arrays, they will be concatenated, if common keys are both objects, they will be merged. Incompatible types, e.g. an object and an array will use the later source.
Type Parameters
- A
- B
- C
- D
Parameters
- sources: readonly [A, B, C, D]
- Optionaloptions: Partial<MergeOptions>
Returns A & B & C & D
- Defined in util/object/mergeDeep.ts:60
mergeDeep<A, B, C, D, E>(
sources: readonly [A, B, C, D, E],
options?: Partial<MergeOptions>,
): A & B & C & D & E
Deep merges the five objects. If common keys are both arrays, they will be concatenated, if common keys are both objects, they will be merged. Incompatible types, e.g. an object and an array will use the later source.
Type Parameters
- A
- B
- C
- D
- E
Parameters
- sources: readonly [A, B, C, D, E]
- Optionaloptions: Partial<MergeOptions>
Returns A & B & C & D & E
- Defined in util/object/mergeDeep.ts:70
mergeDeep<A, B, C, D, E, F>(
sources: readonly [A, B, C, D, E, F],
options?: Partial<MergeOptions>,
): A & B & C & D & E & F
Deep merges the six objects. If common keys are both arrays, they will be concatenated, if common keys are both objects, they will be merged. Incompatible types, e.g. an object and an array will use the later source.
Type Parameters
- A
- B
- C
- D
- E
- F
Parameters
- sources: readonly [A, B, C, D, E, F]
- Optionaloptions: Partial<MergeOptions>
Returns A & B & C & D & E & F
- Defined in util/object/mergeDeep.ts:80
mergeDeep(sources: readonly any[], options?: Partial<MergeOptions>): any
Deep merges all objects. If common keys are both arrays, they will be concatenated, if common keys are both objects, they will be merged. Incompatible types, e.g. an object and an array will use the later source.
Parameters
- sources: readonly any[]
- Optionaloptions: Partial<MergeOptions>
Returns any
- Defined in util/object/mergeDeep.ts:90

Function mergeDeep

Param: sources

Param: options

See

Type Parameters

Parameters

Returns T

Type Parameters

Parameters

Returns T

Type Parameters

Parameters

Returns A & B

Type Parameters

Parameters

Returns A & B & C

Type Parameters

Parameters

Returns A & B & C & D

Type Parameters

Parameters

Returns A & B & C & D & E

Type Parameters

Parameters

Returns A & B & C & D & E & F

Parameters

Returns any

Settings