Skip to content

toMerged

Import from @varavel/vdl-plugin-sdk/utils/objects.

function toMerged<T, S>(target, source): T & S;

Merges the properties of the source object into a deep clone of the target object. Unlike merge, This function does not modify the original target object.

This function performs a deep merge, meaning nested objects and arrays are merged recursively.

  • If a property in the source object is an array or object and the corresponding property in the target object is also an array or object, they will be merged.
  • If a property in the source object is undefined, it will not overwrite a defined property in the target object.

Note that this function does not mutate the target object.

Type Parameters

Type Parameter Description
T extends Record\<PropertyKey, any> Type of the target object.
S extends Record\<PropertyKey, any> Type of the source object.

Parameters

Parameter Type Description
target T The target object to be cloned and merged into. This object is not modified directly.
source S The source object whose properties will be merged into the cloned target object.

Returns

T & S

A new object with properties from the source object merged into a deep clone of the target object.

Examples

const target = { a: 1, b: { x: 1, y: 2 } };
const source = { b: { y: 3, z: 4 }, c: 5 };

const result = toMerged(target, source);
console.log(result);
// Output: { a: 1, b: { x: 1, y: 3, z: 4 }, c: 5 }

const target = { a: [1, 2], b: { x: 1 } };
const source = { a: [3], b: { y: 2 } };

const result = toMerged(target, source);
console.log(result);
// Output: { a: [3, 2], b: { x: 1, y: 2 } }

const target = { a: null };
const source = { a: [1, 2, 3] };

const result = toMerged(target, source);
console.log(result);
// Output: { a: [1, 2, 3] }