Skip to content

Commit 552f165

Browse files
author
DoneDeal0
authored
Update README.md
1 parent b844981 commit 552f165

File tree

1 file changed

+52
-52
lines changed

1 file changed

+52
-52
lines changed

README.md

Lines changed: 52 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -8,23 +8,23 @@ This library compares two arrays or objects and return a complete diff of their
88

99
Input
1010

11-
```js
11+
```diff
1212
getObjectDiff(
1313
{
1414
id: 54,
1515
user: {
1616
name: "joe",
17-
member: true,
18-
hobbies: ["golf", "football"],
17+
- member: true,
18+
- hobbies: ["golf", "football"],
1919
age: 66,
2020
},
2121
},
2222
{
2323
id: 54,
2424
user: {
2525
name: "joe",
26-
member: false,
27-
hobbies: ["golf", "chess"],
26+
+ member: false,
27+
+ hobbies: ["golf", "chess"],
2828
age: 66,
2929
},
3030
}
@@ -33,10 +33,10 @@ getObjectDiff(
3333

3434
Output
3535

36-
```js
36+
```diff
3737
{
3838
type: "object",
39-
status: "updated",
39+
+ status: "updated",
4040
diff: [
4141
{
4242
property: "id",
@@ -58,26 +58,26 @@ Output
5858
hobbies: ["golf", "chess"],
5959
age: 66,
6060
},
61-
status: "updated",
61+
+ status: "updated",
6262
subPropertiesDiff: [
6363
{
6464
name: "name",
6565
previousValue: "joe",
6666
currentValue: "joe",
6767
status: "equal",
6868
},
69-
{
70-
name: "member",
71-
previousValue: true,
72-
currentValue: false,
73-
status: "updated",
74-
},
75-
{
76-
name: "hobbies",
77-
previousValue: ["golf", "football"],
78-
currentValue: ["golf", "chess"],
79-
status: "updated",
80-
},
69+
+ {
70+
+ name: "member",
71+
+ previousValue: true,
72+
+ currentValue: false,
73+
+ status: "updated",
74+
+ },
75+
+ {
76+
+ name: "hobbies",
77+
+ previousValue: ["golf", "football"],
78+
+ currentValue: ["golf", "chess"],
79+
+ status: "updated",
80+
+ },
8181
{
8282
name: "age",
8383
previousValue: 66,
@@ -97,19 +97,19 @@ It doesn't work yet with duplicated values.
9797

9898
Input
9999

100-
```js
100+
```diff
101101
getListDiff(
102-
["mbappe", "mendes", "verratti", "ruiz"],
103-
["mbappe", "messi", "ruiz"]
102+
- ["mbappe", "mendes", "verratti", "ruiz"],
103+
+ ["mbappe", "messi", "ruiz"]
104104
);
105105
```
106106

107107
Output
108108

109-
```js
109+
```diff
110110
{
111111
type: "list",
112-
status: "updated",
112+
+ status: "updated",
113113
diff: [
114114
{
115115
value: "mbappe",
@@ -118,33 +118,33 @@ Output
118118
indexDiff: 0,
119119
status: "equal",
120120
},
121-
{
122-
value: "mendes",
123-
prevIndex: 1,
124-
newIndex: null,
125-
indexDiff: null,
126-
status: "deleted",
127-
},
128-
{
129-
value: "verratti",
130-
prevIndex: 2,
131-
newIndex: null,
132-
indexDiff: null,
133-
status: "deleted",
134-
},
135-
{
136-
value: "messi",
137-
prevIndex: null,
138-
newIndex: 1,
139-
indexDiff: null,
140-
status: "added",
141-
},
142-
{
143-
value: "ruiz",
144-
prevIndex: 3,
145-
newIndex: 2,
146-
indexDiff: -1,
147-
status: "moved",
121+
- {
122+
- value: "mendes",
123+
- prevIndex: 1,
124+
- newIndex: null,
125+
- indexDiff: null,
126+
- status: "deleted",
127+
- },
128+
- {
129+
- value: "verratti",
130+
- prevIndex: 2,
131+
- newIndex: null,
132+
- indexDiff: null,
133+
- status: "deleted",
134+
- },
135+
+ {
136+
+ value: "messi",
137+
+ prevIndex: null,
138+
+ newIndex: 1,
139+
+ indexDiff: null,
140+
+ status: "added",
141+
+ },
142+
+ {
143+
+ value: "ruiz",
144+
+ prevIndex: 3,
145+
+ newIndex: 2,
146+
+ indexDiff: -1,
147+
+ status: "moved",
148148
},
149149
],
150150
}

0 commit comments

Comments
 (0)