Skip to content

Commit

Permalink
Update description
Browse files Browse the repository at this point in the history
  • Loading branch information
jhildenbiddle committed Jan 13, 2024
1 parent 17ea783 commit eaea718
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 6 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@
[![jsDelivr](https://data.jsdelivr.com/v1/package/npm/mergician/badge)](https://www.jsdelivr.com/package/npm/mergician)
[![Sponsor this project](https://img.shields.io/static/v1?style=flat-square&label=Sponsor&message=%E2%9D%A4&logo=GitHub&color=%23fe8e86)](https://github.com/sponsors/jhildenbiddle)

Mergician is a uniquely flexible and light-weight utility for deep (recursive) merging/cloning of JavaScript objects.
Mergician is a uniquely flexible and light-weight utility for cloning and deep (recursive) merging of JavaScript objects.

Unlike native methods and other merge/clone utilities, Mergician provides advanced options for customizing the merge/clone process. These options make it easy to inspect, filter, and modify keys and properties; merge or skip unique, common, and universal keys (i.e., intersections, unions, and differences); and merge, sort, and remove duplicates from arrays. Property [accessors](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Property_accessors) and [descriptors](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/getOwnPropertyDescriptor) are also handled properly, ensuring that getter/setter functions are retained and descriptor values are defined on new merged/cloned objects.
Unlike native methods and other clone/merge utilities, Mergician faithfully handles [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 custom prototype properties while providing options for customizing the clone/merge process. These options make it easy to inspect, filter, and modify properties; merge or skip common, universal, and unique keys (i.e., intersections, unions, and differences); merge, sort, and remove duplicate array items; and merge, hoist, and skip prototype properties.

- [Documentation & Demos](https://jhildenbiddle.github.io/mergician/)

Expand Down
6 changes: 3 additions & 3 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@
[![Add a star on GitHub](https://img.shields.io/github/stars/jhildenbiddle/mergician?style=social)](https://github.com/jhildenbiddle/mergician)
[![Tweet](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)](https://twitter.com/intent/tweet?url=https%3A%2F%2Fgithub.com%2Fjhildenbiddle%2Fmergician&hashtags=developers,frontend,javascript)

Mergician is a uniquely flexible and light-weight utility for deep (recursive) merging/cloning of JavaScript objects.
Mergician is a uniquely flexible and light-weight utility for cloning and deep (recursive) merging of JavaScript objects.

Unlike native methods and other merge/clone utilities, Mergician provides advanced options for customizing the merge/clone process. These options make it easy to inspect, filter, and modify keys and properties; merge or skip unique, common, and universal keys (i.e., intersections, unions, and differences); and merge, sort, and remove duplicates from arrays. Property [accessors](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Property_accessors) and [descriptors](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/getOwnPropertyDescriptor) are also handled properly, ensuring that getter/setter functions are retained and descriptor values are defined on new merged/cloned objects.
Unlike native methods and other clone/merge utilities, Mergician faithfully handles [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 custom prototype properties while providing options for customizing the clone/merge process. These options make it easy to inspect, filter, and modify properties; merge or skip common, universal, and unique keys (i.e., intersections, unions, and differences); merge, sort, and remove duplicate array items; and merge, hoist, and skip prototype properties.

## Demo

Expand Down Expand Up @@ -496,7 +496,7 @@ console.log(mergedDescending); // { a: [6, 5, 4, 3, 2, 1] }

### hoistEnumerable()

Clone enumerable prototype properties as direct properties of merged/cloned object.
Clone enumerable prototype properties as direct properties of new clone/merge object.

- Type: `Boolean`
- Default: `false`
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "mergician",
"version": "1.1.0",
"description": "Uniquely flexible and light-weight utility for deep (recursive) merging/cloning of JavaScript objects. Provides advanced options for customizing the merge/clone process: inspect, filter, and modify keys and properties; merge or skip unique, common, and universal keys (i.e., intersections, unions, and differences); and merge, sort, and remove duplicates from arrays. Handles property accessors and descriptors, ensuring that getter/setter functions are retained and descriptor values are defined properly on new merged/cloned objects.",
"description": "Uniquely flexible and light-weight utility for cloning and deep (recursive) merging of JavaScript objects. Handles descriptor values, accessor functions, and custom prototype properties. Provides advanced options for customizing the merge/clone process: inspect, filter, and modify properties; merge or skip common, universal, and unique keys (intersections, unions, and differences); merge, sort, and remove duplicate array items; and merge, hoist, and skip prototype properties.",
"author": "John Hildenbiddle",
"license": "MIT",
"homepage": "https://jhildenbiddle.github.io/mergician/",
Expand Down

0 comments on commit eaea718

Please sign in to comment.