feat: Cleaning up the API to support more options.

BREAKING CHANGE

.gitignore

@@ -14,6 +14,7 @@ lib-cov
 
 # Coverage directory used by tools like istanbul
 coverage
+docs
 
 # node-waf configuration
 .lock-wscript

.npmrc

@@ -0,0 +1 @@
+package-lock = false

doc.json

@@ -0,0 +1,8 @@
+{
+  "source": "./src",
+  "destination": "./docs",
+  "test": {
+    "type": "mocha",
+    "source": "./test"
+  }
+}

package.json

@@ -9,8 +9,10 @@
     "lint": "standard",
     "coverage": "nyc npm t && npm run coverage-report",
     "coverage-report": "nyc report --reporter=lcov",
+    "doc": "esdoc -c doc.json",
     "test": "npm run build && _mocha --compilers js:babel-register",
     "prebuild": "rimraf dist",
+    "predoc": "rimraf docs",
     "build": "babel --copy-files --out-dir dist src",
     "travis": "npm run precommit",
     "semantic-release": "semantic-release pre && npm publish && semantic-release post"
@@ -47,6 +49,7 @@
     "chai": "^4.0.2",
     "commitizen": "^2.8.2",
     "cz-conventional-changelog": "^2.0.0",
+    "esdoc": "^0.5.2",
     "mocha": "^3.4.1",
     "nyc": "^11.0.1",
     "rimraf": "^2.5.2",

src/json-truncate.js

@@ -1,22 +1,27 @@
-'use strict'
+// configurables
+let maxDepth = 10
+let replace
 
 const flatTypes = [String, Number, Boolean]
 
-const isDefined = val => {
-  return val !== null && val !== undefined
-}
+const isDefined = val => val !== null && val !== undefined
 
-const isFlat = val => {
-  return !isDefined(val) || flatTypes.indexOf(val.constructor) !== -1
-}
+const isFlat = val => !isDefined(val) || flatTypes.indexOf(val.constructor) !== -1
 
-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
+/**
+ * Truncates variables.
+ * @param {Object} obj - The object to truncate.
+ * @param {Object=} options - Configurable options.
+ * @param {Number=} [options.maxDepth=10] - The max depth to build.
+ * @param {Object=} options.replace - What to replace the truncated reference to.
+ * @param {Number} [curDepth=0] - The current depth (used for recursive requests).
+ * @returns {Object} The truncated object.
+ */
+const truncate = (obj, options = {}, curDepth = 0) => {
+  options.maxDepth = options.maxDepth || maxDepth
+  options.replace = options.replace || replace
 
-  if (curDepth < maxDepth) {
+  if (curDepth < options.max) {
     const newDepth = curDepth + 1
 
     if (isFlat(obj)) {
@@ -27,7 +32,7 @@ const truncate = (obj, maxDepth, options, curDepth) => {
         if (isFlat(value)) {
           newArr.push(value)
         } else {
-          newArr.push(truncate(value, maxDepth, options, newDepth))
+          newArr.push(truncate(value, options, newDepth))
         }
       })
       return newArr
@@ -37,13 +42,25 @@ const truncate = (obj, maxDepth, options, curDepth) => {
         if (isFlat(obj[key])) {
           newObj[key] = obj[key]
         } else {
-          newObj[key] = truncate(obj[key], maxDepth, options, newDepth)
+          newObj[key] = truncate(obj[key], options, newDepth)
         }
       }
       return newObj
     }
   }
+
   return options.replace
 }
 
+/**
+ * Configures globals and defaults.
+ * @param {Object=} obj - The configuration.
+ * @param {Number} obj.maxDepth - The default and global maxDepth for future truncations.
+ * @param {} obj.replace - The default and global replacement value.
+ */
+export const configure = (obj = {}) => {
+  maxDepth = obj.maxDepth || maxDepth
+  replace = obj.replace || replace
+}
+
 export default truncate