Skip to content

Commit c8efe46

Browse files
committed
Incremented version and added cycles section
1 parent cd0b866 commit c8efe46

File tree

2 files changed

+9
-1
lines changed

2 files changed

+9
-1
lines changed

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,14 @@ The `path` property gives a path to the property in the new object (or the old o
5454
Each element in the paths is a key to the next property a level deeper until you get to the property changed, and it is string or a number, depending on whether the object is an Array or Object (Objects with number keys will still be strings).
5555
The `value` property exists in types `CREATE` and `CHANGE`, and it contains the value of the property added/changed.
5656

57+
# Cycles support
58+
59+
By default cycles are supported, but if you are sure that the object has no cycles (for example if you are parsing JSON) you can disable cycles using the `cyclesFix` option.
60+
61+
```js
62+
diff(obj1, obj2, { cyclesFix: false });
63+
```
64+
5765
# Benchmarks
5866

5967
```

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "microdiff",
3-
"version": "1.1.3",
3+
"version": "1.2.0",
44
"description": "Small, fast, zero dependency deep object and array comparison",
55
"main": "./dist/index.cjs",
66
"module": "./dist/index.js",

0 commit comments

Comments
 (0)