-
-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore(release): 1.1.8-beta.1 [skip ci]
## [1.1.8-beta.1](v1.1.7...v1.1.8-beta.1) (2021-11-22) ### Bug Fixes * add better support for readonly types ([#17](#17)) ([0609832](0609832))
- Loading branch information
1 parent
5493da5
commit 503bb37
Showing
16 changed files
with
2,234 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| BSD 3-Clause License | ||
|
|
||
| Copyright (c) 2021, Rebecca Stevens | ||
| All rights reserved. | ||
|
|
||
| Redistribution and use in source and binary forms, with or without | ||
| modification, are permitted provided that the following conditions are met: | ||
|
|
||
| 1. Redistributions of source code must retain the above copyright notice, this | ||
| list of conditions and the following disclaimer. | ||
|
|
||
| 2. Redistributions in binary form must reproduce the above copyright notice, | ||
| this list of conditions and the following disclaimer in the documentation | ||
| and/or other materials provided with the distribution. | ||
|
|
||
| 3. Neither the name of the copyright holder nor the names of its | ||
| contributors may be used to endorse or promote products derived from | ||
| this software without specific prior written permission. | ||
|
|
||
| THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" | ||
| AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | ||
| IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE | ||
| DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE | ||
| FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL | ||
| DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR | ||
| SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER | ||
| CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, | ||
| OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE | ||
| OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,134 @@ | ||
| <div align="center"> | ||
|
|
||
| # DeepmergeTS | ||
|
|
||
| [](https://www.npmjs.com/package/deepmerge-ts) | ||
| [](https://deno.land/x/deepmergets) | ||
| [](https://github.com/RebeccaStevens/deepmerge-ts/actions/workflows/ci.yml) | ||
| [](https://codecov.io/gh/RebeccaStevens/deepmerge-ts)\ | ||
| [](https://github.com/prettier/prettier) | ||
| [](https://github.com/RebeccaStevens/deepmerge-ts/discussions) | ||
| [](https://opensource.org/licenses/BSD-3-Clause) | ||
| [](https://commitizen.github.io/cz-cli/) | ||
| [](https://github.com/semantic-release/semantic-release) | ||
|
|
||
| Deeply merge 2 or more objects respecting type information. | ||
|
|
||
|  | ||
|
|
||
| </div> | ||
|
|
||
| ## Installation | ||
|
|
||
| ### Node | ||
|
|
||
| ```sh | ||
| # Install with npm | ||
| npm install deepmerge-ts --save-dev | ||
|
|
||
| # Install with yarn | ||
| yarn add -D deepmerge-ts | ||
| ``` | ||
|
|
||
| ### Deno | ||
|
|
||
| ```jsonc | ||
| // 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 | ||
|
|
||
| ```js | ||
| 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](./docs/deepmergeCustom.md). | ||
|
|
||
| ## 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](./docs/API.md). |
Oops, something went wrong.