# @corex/deepmerge

> A zero dependency object merger with typescript support and built in common merge utilities.

Latest version **4.0.43** (published 2023-04-12) · MIT license · 0 weekly downloads

## Install

```sh
npm install @corex/deepmerge
pnpm add @corex/deepmerge
yarn add @corex/deepmerge
bun add @corex/deepmerge
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 4.0.43 |
| Published | 2023-04-12 |
| First published | 2020-08-09 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 16.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | iamvishnusankar |
| Keywords | deepmerge, typescript |

## Links

- npm: https://www.npmjs.com/package/@corex/deepmerge
- npm.io page: https://npm.io/package/@corex/deepmerge

## Alternatives

- [@openai/codex-sdk](https://npm.io/package/@openai/codex-sdk.md) — 731.4K weekly downloads
- [babel-plugin-transform-react-jsx](https://npm.io/package/babel-plugin-transform-react-jsx.md) — 565.0K weekly downloads
- [babel-helper-remove-or-void](https://npm.io/package/babel-helper-remove-or-void.md) — 508.5K weekly downloads
- [@pnpm/store-controller-types](https://npm.io/package/@pnpm/store-controller-types.md) — 186.9K weekly downloads
- [react-native-signature-canvas](https://npm.io/package/react-native-signature-canvas.md) — 155.6K weekly downloads

## Recent versions

- 4.0.43 (latest) — 2023-04-12
- 4.0.37 — 2023-01-10
- 4.0.29 — 2022-06-29
- 4.0.26 — 2022-06-20
- 4.0.24 — 2022-06-19
- 4.0.22 — 2022-06-13
- 4.0.19 — 2022-06-13
- 4.0.18 — 2022-06-13
- 4.0.16 — 2022-06-03
- 4.0.14 — 2022-05-31
- 4.0.12 — 2022-05-31
- 4.0.11 — 2022-05-31
- 4.0.9 — 2022-05-31
- 3.0.611 — 2022-05-29
- 3.0.600 — 2022-05-29
- … 95 more at https://npm.io/package/@corex/deepmerge/versions

## README

---
title: '@corex/deepmerge'
custom_edit_url: 'https://github.com/iamvishnusankar/corex/edit/master/packages/deepmerge/README.md'
---

A zero dependency object merger with typescript support and built in common merge utilities. Support merging of n number of objects

## Installation

```
yarn add @corex/deepmerge
```

## Usage

```ts
import { merge } from '@corex/deepmerge'

merge([obj1, obj2, obj3], { options })
```

## Merge Options

| property       | default   | description                                                                                          |
| -------------- | --------- | ---------------------------------------------------------------------------------------------------- |
| arrayMergeType | `combine` | Merge two array by concatenation and remove duplicates. Available options are `combine`, `overwrite` |
| arrayMerge     | -         | Custom merge function to handle array merging.                                                       |

## Simple Object Merge

```ts
const obj1 = {
  a: 1,
  b: {
    c: 2,
  },
}

const obj2 = {
  a: 2,
  b: {
    c: 4,
    d: 5,
  },
}

const result = merge([obj1, obj2])
console.log(result)

// {
//   a: 2,
//   b: {
//     c: 4,
//     d: 5,
//   },
// }
```

## Array Merge

```ts
const arr1 = {
  a: [1, 2, 3],
}
const arr2 = {
  a: [3, 4, 5],
}

const result = merge([arr1, arr2])
console.log(result)

// result = {
//   a: [1, 2, 3, 4, 5],
// }
```

## Complex Merge

```ts
const obj1 = {
  a: 2,
  b: (x: number, y: number) => x + y,
  c: [1, 2, 4],
  d: {
    e: [4, 5, 7],
  },
}

console.log(obj1.b(7, 5)) // ==> 12

const obj2 = {
  a: 10,
  b: (x: number, y: number) => x / y,
  c: [20, 30],
  d: {
    e: [4, 7, 5],
    f: {
      g: 'another',
    },
  },
}

const obj3 = {
  b: (x: number, y: number) => x * y,
  c: [1, 2, 4],
  d: {
    e: [4, 7, 5],
  },
}

const result = merge([obj1, obj2, obj3])

console.log(result.b(7, 5)) // ==> 35
```

## Array merge types

By default `@corex/deepmerge` uses combine merge. However user can implement their own methods to perform merge or use the built in `overwrite`.

### Overwrite merge

```ts
const obj1 = {
  a: [1, 2, 3],
  b: ['c', 'd'],
  c: {
    d: [1, 2],
  },
}

const obj2 = {
  a: [1, 7, 6],
  b: ['e', 'f'],
  c: {
    d: [9, 10],
  },
}

const obj3 = {
  a: [20, 40],
}

const result = merge([obj1, obj2, obj3], {
  arrayMergeType: 'overwrite',
})
console.log(result)

// result = {
//   a: [20, 40],
//   b: ['e', 'f'],
//   c: {
//     d: [9, 10],
//   },
// }
```

### Custom merge function

```ts
const obj1 = {
  a: ['1', '2'],
  c: {
    d: [1000, 500],
  },
}

const obj2 = {
  a: ['4', '5'],
  c: {
    d: [60, 80],
  },
}

const customMergeFn = (_: any[], __: any[]) => 42

const result = merge([obj1, obj2], {
  arrayMerge: customMergeFn,
})
console.log(result)

// {
//   a: 42,
//   c: {
//     d: 42,
//   },
// }
```

---
_Source: https://npm.io/package/@corex/deepmerge · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
