Skip to content

Commit 2b22e6b

Browse files
committedJul 28, 2019
docs: update readme
1 parent 7cc6574 commit 2b22e6b

File tree

1 file changed

+58
-32
lines changed

1 file changed

+58
-32
lines changed
 

‎README.md

+58-32
Original file line numberDiff line numberDiff line change
@@ -1,58 +1,84 @@
11
# Merge
22

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.
64

7-
## Node.js Usage
5+
# Install
6+
7+
## Node.js
88

99
```sh
10-
npm install merge --save
10+
npm i merge
11+
```
12+
```js
13+
import merge from 'merge'
1114
```
1215

16+
## Browser
17+
18+
```html
19+
<script src="https://cdn.jsdelivr.net/gh/yeikos/js.merge/dist/merge.browser.min.js"></script>
20+
```
1321
```js
14-
var merge = require('merge'), original, cloned;
22+
window.merge
23+
```
1524

16-
console.log(merge({one:'hello'}, {two: 'world'}));
17-
// -> {"one": "hello", "two": "world"}
25+
# API
1826

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+
```
2233

23-
console.log(original.x.y, cloned.x.y);
24-
// -> 1, 2
34+
# Examples
2535

26-
console.log(merge.recursive(true, original, { x: { z: 2 } }));
27-
// -> {"x": { "y": 1, "z": 2 } }
36+
```js
2837

29-
```
38+
// Merge
3039

31-
## Browser Usage
40+
{
41+
var objectA = {}
3242

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+
)
3747

38-
console.log(merge({one:'hello'}, {two: 'world'}));
39-
// -> {"one": "hello", "two": "world"}
48+
var objectB = merge(true, objectA,
49+
{ value: 2 }
50+
)
4051

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+
}
4455

45-
console.log(original.x.y, cloned.x.y);
46-
// -> 1, 2
56+
// Recursive merge
4757

48-
console.log(merge.recursive(true, original, { x: { z: 2 } }));
49-
// -> {"x": { "y": 1, "z": 2 } }
58+
{
59+
var objectA = {}
5060

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+
}
5272
```
73+
# Test
5374

54-
## Tests
75+
## Node.js
5576

5677
```sh
5778
npm test
5879
```
80+
## Browser
81+
82+
```
83+
./dist/merge.browser.test.html
84+
```

0 commit comments

Comments
 (0)
Please sign in to comment.