https://github.com/jhildenbiddle/mergician
Uniquely flexible and light-weight utility for cloning and deep (recursive) merging of JavaScript objects. Supports descriptor values, accessor functions, and custom prototypes. Provides advanced options for customizing the clone/merge process.
https://github.com/jhildenbiddle/mergician
accessor array clone copy deep deep-merge deepmerge descriptor duplicate extend filter getter immutable javascript merge merge-deep object recursive setter sort
Last synced: 2 months ago
JSON representation
Uniquely flexible and light-weight utility for cloning and deep (recursive) merging of JavaScript objects. Supports descriptor values, accessor functions, and custom prototypes. Provides advanced options for customizing the clone/merge process.
- Host: GitHub
- URL: https://github.com/jhildenbiddle/mergician
- Owner: jhildenbiddle
- License: mit
- Created: 2022-06-22T22:08:32.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-08-21T10:58:37.000Z (10 months ago)
- Last Synced: 2025-04-03T02:02:52.702Z (3 months ago)
- Topics: accessor, array, clone, copy, deep, deep-merge, deepmerge, descriptor, duplicate, extend, filter, getter, immutable, javascript, merge, merge-deep, object, recursive, setter, sort
- Language: JavaScript
- Homepage: https://jhildenbiddle.github.io/mergician/
- Size: 912 KB
- Stars: 78
- Watchers: 2
- Forks: 5
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Mergician
[](https://www.npmjs.com/package/mergician)
[](https://github.com/jhildenbiddle/mergician/actions?query=branch%3Amain+)
[](https://app.codacy.com/gh/jhildenbiddle/mergician/dashboard?branch=main)
[](https://github.com/jhildenbiddle/mergician/blob/main/LICENSE)
[](https://www.jsdelivr.com/package/npm/mergician)
[](https://github.com/sponsors/jhildenbiddle)
Mergician is a uniquely flexible and light-weight utility for cloning and deep (recursive) merging of JavaScript objects.
Unlike native methods and other utilities, Mergician faithfully clones and merges objects by properly handling [descriptor](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/getOwnPropertyDescriptor) values, [accessor](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Property_accessors) functions, and prototype properties while offering advanced options for customizing the clone/merge process.
- 🚀 [Documentation & Demos](https://jhildenbiddle.github.io/mergician/)
## Features
- Deep (recursive) clone/merge JavaScript objects
- Generates new object without modifying source object(s)
- Clone/merge enumerable and non-enumerable properties
- Clone/merge property [descriptor](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/getOwnPropertyDescriptor) values
- Retain, skip, or convert [accessor](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Property_accessors) functions to static values
- Inspect, filter, and modify properties
- Merge, skip, or hoist prototype properties
- Merge or skip key intersections, unions, and differences
- Merge, sort, and remove duplicate array items
- IntelliSense / code hinting support
- TypeScript support
- Lightweight (2k min+gzip) and dependency-free
**Platform Support**
Node 10+
Chrome 61+
Edge 16+
Firefox 60+
Safari 10.1+
## Examples
Basic object cloning using default options:
```javascript
// ES module shown. CommonJS module also available (see below).
import { mergician } from 'mergician';
const obj1 = { a: [1, 1], b: { c: 1, d: 1 } };
const clonedObj = mergician({}, obj1);
// Results
console.log(clonedObj); // { a: [1, 1], b: { c: 1, d: 1 } }
console.log(clonedObj === obj1); // false
console.log(clonedObj.a === obj1.a); // false
console.log(clonedObj.b === obj1.b); // false
```
Advanced object merging using custom options:
```javascript
// ES module shown. CommonJS module also available (see below).
import { mergician } from 'mergician';
const obj1 = { a: [1, 1], b: { c: 1, d: 1 } };
const obj2 = { a: [2, 2], b: { c: 2 } };
const obj3 = { e: 3 };
const mergedObj = mergician({
skipKeys: ['d'],
appendArrays: true,
dedupArrays: true,
filter({ depth, key, srcObj, srcVal, targetObj, targetVal }) {
if (key === 'e') {
targetObj['hello'] = 'world';
return false;
}
}
})(obj1, obj2, obj3);
// Result
console.log(mergedObj); // { a: [1, 2], b: { c: 2 }, hello: 'world' }
```
## Installation
**NPM**
```bash
npm install mergician
```
```javascript
// ES module
import { mergician } from 'mergician';
```
```javascript
// CommonJS module
const { mergician } = require('mergician');
```
**CDN**
Available on [jsdelivr](https://www.jsdelivr.com/package/npm/mergician) (below), [unpkg](https://unpkg.com/browse/mergician/), and other CDN services that auto-publish npm packages.
> 💡 Note the `@` version lock in the URLs below. This prevents breaking changes in future releases from affecting your project and is therefore the safest method of loading dependencies from a CDN. When a new major version is released, you will need to manually update your CDN URLs by changing the version after the `@` symbol.
```javascript
// ES module @ latest v2.x.x
import { mergician } from 'https://cdn.jsdelivr.net/npm/mergician@2';
```
## Usage & Options
See the [documentation site](https://jhildenbiddle.github.io/mergician/) for details.
## Sponsorship
A [sponsorship](https://github.com/sponsors/jhildenbiddle) is more than just a way to show appreciation for the open-source authors and projects we rely on; it can be the spark that ignites the next big idea, the inspiration to create something new, and the motivation to share so that others may benefit.
If you benefit from this project, please consider lending your support and encouraging future efforts by [becoming a sponsor](https://github.com/sponsors/jhildenbiddle).
Thank you! 🙏🏻
## Contact & Support
- Follow 👨🏻💻 **@jhildenbiddle** on [Twitter](https://twitter.com/jhildenbiddle) and [GitHub](https://github.com/jhildenbiddle) for announcements
- Create a 💬 [GitHub issue](https://github.com/jhildenbiddle/mergician/issues) for bug reports, feature requests, or questions
- Add a ⭐️ [star on GitHub](https://github.com/jhildenbiddle/mergician) and 🐦 [tweet](https://twitter.com/intent/tweet?url=https%3A%2F%2Fgithub.com%2Fjhildenbiddle%2Fmergician&hashtags=developers,frontend,javascript) to promote the project
- Become a 💖 [sponsor](https://github.com/sponsors/jhildenbiddle) to support the project and future efforts
## License
This project is licensed under the [MIT license](https://github.com/jhildenbiddle/mergician/blob/main/LICENSE).
Copyright (c) John Hildenbiddle ([@jhildenbiddle](https://twitter.com/jhildenbiddle))