json-truncate - npm Package Compare versions

Comparing version 1.1.4 to 1.2.0

dist/json-truncate.js

@@ -7,3 +7,3 @@ 'use strict';
 
-var _typeof = typeof Symbol === "function" && typeof Symbol.iterator === "symbol" ? function (obj) { return typeof obj; } : function (obj) { return obj && typeof Symbol === "function" && obj.constructor === Symbol ? "symbol" : typeof obj; };
+var _typeof = typeof Symbol === "function" && typeof Symbol.iterator === "symbol" ? function (obj) { return typeof obj; } : function (obj) { return obj && typeof Symbol === "function" && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; };
 
@@ -20,5 +20,7 @@ var flatTypes = [String, Number, Boolean];
 
-var truncate = function truncate(obj, maxDepth, curDepth) {
+var truncate = function truncate(obj, maxDepth, options, curDepth) {
   curDepth = curDepth || 0;
   maxDepth = isDefined(maxDepth) ? maxDepth : 10;
+  options = (typeof options === 'undefined' ? 'undefined' : _typeof(options)) === 'object' ? options : {};
+  options.replace = typeof options.replace === 'string' ? options.replace : undefined;
 
@@ -40,3 +42,3 @@ if (curDepth < maxDepth) {
             } else {
-              newArr.push(truncate(value, maxDepth, newDepth));
+              newArr.push(truncate(value, maxDepth, options, newDepth));
             }
@@ -58,3 +60,3 @@ });
           } else {
-            newObj[key] = truncate(obj[key], maxDepth, newDepth);
+            newObj[key] = truncate(obj[key], maxDepth, options, newDepth);
           }
@@ -70,4 +72,5 @@ }
   }
+  return options.replace;
 };
 
 exports.default = truncate;

package.json

 {
   "name": "json-truncate",
-  "version": "1.1.4",
+  "version": "1.2.0",
   "description": "A way to truncate a json object.",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -29,2 +29,6 @@ # json-truncate
 console.log(JSON.truncate(SomeDeepObject, 10));
+
+//OR specify a replacement string for truncated values
+
+console.log(JSON.truncate(SomeDeepObject, 10, {replace: '[Truncated]'}));
 ```
@@ -40,6 +44,13 @@
 * `maxDepth` - (optional) The depth at which to stop building the valid json. Defaults to `10`.
+* `options` - (optional) An option object to customize the behavior of the utility. Defaults to `{}`.
 
+**Current Option Properties**
 
+|Option|Description|
+|:--|:--|
+|**replace**|A string value that is used to replace all truncated values. If this value is not a string then all truncated values will be replaced with `undefined`|
+
+
 ## Licence
 
 MIT

src/json-truncate.js

@@ -13,5 +13,7 @@ 'use strict'
 
-const truncate = (obj, maxDepth, curDepth) => {
+const truncate = (obj, maxDepth, options, curDepth) => {
   curDepth = curDepth || 0
   maxDepth = (isDefined(maxDepth)) ? maxDepth : 10
+  options = (typeof options === 'object') ? options : {}
+  options.replace = (typeof options.replace === 'string') ? options.replace : undefined
 
@@ -29,3 +31,3 @@ if (curDepth < maxDepth) {
         } else {
-          newArr.push(truncate(value, maxDepth, newDepth))
+          newArr.push(truncate(value, maxDepth, options, newDepth))
         }
@@ -40,3 +42,3 @@ })
         } else {
-          newObj[key] = truncate(obj[key], maxDepth, newDepth)
+          newObj[key] = truncate(obj[key], maxDepth, options, newDepth)
         }
@@ -47,4 +49,5 @@ }
   }
+  return options.replace
 }
 
 export default truncate

No alert changes

Improved metrics

Total package byte prevSize

9012

increased by11.55%

Lines of code

115

increased by5.5%

Number of lines in readme file

55

increased by25%

No dependency changes