DeepmergeTS

Installation

Node

# Install with npm
npm install deepmerge-ts --save-dev

# Install with yarn
yarn add -D deepmerge-ts

Deno

// import_map.json
{
  "imports": {
    "deepmerge-ts": "https://deno.land/x/deepmergets@__version__/dist/deno/index.ts"
  }
}

Features

• Smart merging - High performance.
• Merged output has correct typing.
• Record merging support.
• Array merging support.
• Map and Set merging support.
• Customized merging.

Usage

Example using default config

import { deepmerge } from "deepmerge-ts";

const x = {
  record: {
    prop1: "value1",
    prop2: "value2",
  },
  array: [1, 2, 3],
  set: new Set([1, 2, 3]),
  map: new Map([
    ["key1", "value1"],
    ["key2", "value2"],
  ]),
};

const y = {
  record: {
    prop1: "changed",
    prop3: "value3",
  },
  array: [2, 3, 4],
  set: new Set([2, 3, 4]),
  map: new Map([
    ["key2", "changed"],
    ["key3", "value3"],
  ]),
};

const merged = deepmerge(x, y);

console.log(merged);

// Prettierfied output:
//
// {
//   record: {
//      prop1: "changed",
//      prop2: "value2",
//      prop3: "value3"
//   }
//   array: (6) [1, 2, 3, 2, 3, 4]
//   set: Set(4) {1, 2, 3, 4}
//   map: Map(3) {
//    "key1" => "value1",
//    "key2" => "changed",
//    "key3" => "value3"
//   }
// }

Using customized config

See deepmerge custom docs.

Performance

We use smart merging instead of the classic merging strategy which some alternative libraries use. This vastly improves performance, both in execution time and memory usage.

Classic Merge (not what we do)

With classic merging, each input is merged with the next input until all inputs are merged.

This strategy has large performance issues when lots of items need to be merged.

Smart Merge (what we do)

With our smart merging, we look ahead to see what can be merged and only merge those things.

In addition to performance improvements, this strategy merges multiple inputs at once; allowing for benefits such as taking averages of the inputs.

API

See API docs.