|
1 | 1 | # Merge |
2 | 2 |
|
3 | | -Merge multiple objects into one, optionally creating a new cloned object. |
4 | | -Similar to the jQuery.extend but more flexible. Works in Node.js and the |
5 | | -browser. |
| 3 | +(recursive)? merging of (cloned)? objects. |
6 | 4 |
|
7 | | -## Node.js Usage |
| 5 | +# Install |
| 6 | + |
| 7 | +## Node.js |
8 | 8 |
|
9 | 9 | ```sh |
10 | | -npm install merge --save |
| 10 | +npm i merge |
| 11 | +``` |
| 12 | +```js |
| 13 | +import merge from 'merge' |
11 | 14 | ``` |
12 | 15 |
|
| 16 | +## Browser |
| 17 | + |
| 18 | +```html |
| 19 | +<script src="https://cdn.jsdelivr.net/gh/yeikos/js.merge/dist/merge.browser.min.js"></script> |
| 20 | +``` |
13 | 21 | ```js |
14 | | -var merge = require('merge'), original, cloned; |
| 22 | +window.merge |
| 23 | +``` |
15 | 24 |
|
16 | | -console.log(merge({one:'hello'}, {two: 'world'})); |
17 | | -// -> {"one": "hello", "two": "world"} |
| 25 | +# API |
18 | 26 |
|
19 | | -original = { x: { y: 1 } }; |
20 | | -cloned = merge(true, original); |
21 | | -cloned.x.y++; |
| 27 | +```typescript |
| 28 | +merge(clone: boolean, ...items: Object[]) |
| 29 | +merge(...items: Object[]) |
| 30 | +merge.recursive(clone: boolean, ...items: Object[]) |
| 31 | +merge.recursive(...items: Object[]) |
| 32 | +``` |
22 | 33 |
|
23 | | -console.log(original.x.y, cloned.x.y); |
24 | | -// -> 1, 2 |
| 34 | +# Examples |
25 | 35 |
|
26 | | -console.log(merge.recursive(true, original, { x: { z: 2 } })); |
27 | | -// -> {"x": { "y": 1, "z": 2 } } |
| 36 | +```js |
28 | 37 |
|
29 | | -``` |
| 38 | +// Merge |
30 | 39 |
|
31 | | -## Browser Usage |
| 40 | +{ |
| 41 | + var objectA = {} |
32 | 42 |
|
33 | | -```html |
34 | | -<script src="https://cdn.jsdelivr.net/gh/yeikos/js.merge/merge.js"></script> |
35 | | -<script> |
36 | | - var original, cloned; |
| 43 | + merge(objectA, |
| 44 | + { value: 1 }, |
| 45 | + { str: 'hello world' } |
| 46 | + ) |
37 | 47 |
|
38 | | - console.log(merge({one:'hello'}, {two: 'world'})); |
39 | | - // -> {"one": "hello", "two": "world"} |
| 48 | + var objectB = merge(true, objectA, |
| 49 | + { value: 2 } |
| 50 | + ) |
40 | 51 |
|
41 | | - original = { x: { y: 1 } }; |
42 | | - cloned = merge(true, original); |
43 | | - cloned.x.y++; |
| 52 | + objectA // { value: 1, str: 'hello world' } |
| 53 | + objectB // { value: 2, str: 'hello world' } |
| 54 | +} |
44 | 55 |
|
45 | | - console.log(original.x.y, cloned.x.y); |
46 | | - // -> 1, 2 |
| 56 | +// Recursive merge |
47 | 57 |
|
48 | | - console.log(merge.recursive(true, original, { x: { z: 2 } })); |
49 | | - // -> {"x": { "y": 1, "z": 2 } } |
| 58 | +{ |
| 59 | + var objectA = {} |
50 | 60 |
|
51 | | -</script> |
| 61 | + merge.recursive(objectA, |
| 62 | + { level: { value: 1 } }, |
| 63 | + { level: { str: 'hello world' } } |
| 64 | + ) |
| 65 | + var objectB = merge.recursive(true, objectA, |
| 66 | + { level: { value: 2 } } |
| 67 | + ) |
| 68 | + |
| 69 | + objectA.level // { value: 1, str: 'hello world' } |
| 70 | + objectB.level // { value: 2, str: 'hello world' } |
| 71 | +} |
52 | 72 | ``` |
| 73 | +# Test |
53 | 74 |
|
54 | | -## Tests |
| 75 | +## Node.js |
55 | 76 |
|
56 | 77 | ```sh |
57 | 78 | npm test |
58 | 79 | ``` |
| 80 | +## Browser |
| 81 | + |
| 82 | +``` |
| 83 | +./dist/merge.browser.test.html |
| 84 | +``` |
0 commit comments