merge

sourceが持つ値をtargetオブジェクトにマージします。

この関数は深いマージを実行し、ネストされたオブジェクトや配列も再帰的にマージされます。

• sourceとtargetのプロパティが両方ともオブジェクトまたは配列の場合、2つのオブジェクトと配列はマージされます。
• sourceのプロパティがundefinedの場合、targetのプロパティは上書きされません。

toMergedとは異なり、この関数はtargetオブジェクトを変更します。

インターフェース

function merge<T extends Record<PropertyKey, any>, S extends Record<PropertyKey, any>>(target: T, source: S): T & S;

パラメータ

• target (T): sourceオブジェクトのプロパティをマージするオブジェクト。このオブジェクトは関数によって変更されます。
• source (S): targetオブジェクトにプロパティをマージするオブジェクト。

戻り値

(T & S): sourceオブジェクトのプロパティがマージされたtargetオブジェクト。

例

const target = { a: 1, b: { x: 1, y: 2 } };
const source = { b: { y: 3, z: 4 }, c: 5 };
const result = merge(target, source);
console.log(result);
// 戻り値: { 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 = merge(target, source);
console.log(result);
// 戻り値: { a: [3, 2], b: { x: 1, y: 2 } }

const target = { a: null };
const source = { a: [1, 2, 3] };
const result = merge(target, source);
console.log(result);
// 戻り値: { a: [1, 2, 3] }

デモ

import "./styles.css";

document.getElementById("app").innerHTML = `
<h1>Hello world</h1>
`;

Open Sandbox

パフォーマンス比較

	Bundle Size	Performance
es-toolkit	271 bytes (97.8% smaller)	1,952,436 times (3.65× faster)
es-toolkit/compat	4,381 bytes (64.9% smaller)	706,558 times (1.32× faster)
lodash-es	12,483 bytes	533,484 times