0.0.4

jvandervelden · Apr 13, 2021 · 2a7690e · 2a7690e
1 parent 6a71d93
commit 2a7690e
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -9,6 +9,8 @@ const Compression = require('simple-object-compressor');
 const compression = new Compression({
   testAttribute: 'ta',
   testValue: 'tv',
+}, {
+  maxDepth: -1,
 });
 
 compression.compact({ testAttribute: ['testValue'] });
@@ -18,3 +20,14 @@ compression.expand({ ta: ['tv'] });
 // { testAttribute: ['testValue'] }
 
 ```
+
+## Options
+
+- maxDepth {number} Default -1: Max depth to compress. Root of the object is 0. -1 is no limit. Arrays contents do not count as a depth increase.
+```javascript
+{
+  depth0: {
+    depth1: ['depth1', { depth2: {} }],
+  }
+}
+```
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "simple-object-compressor",
-  "version": "0.0.3",
+  "version": "0.0.4",
   "description": "Compresses/Expands an object's keys by an abbreviation map.",
   "main": "Compression.js",
   "scripts": {