updated:

 * readme
 * variables in toPath
fixed docblock in toPath

lib/toPath.js

@@ -3,23 +3,25 @@
 var path     = require('path');
 var json     = require('../index');
 var includes = require('lodash.includes');
-var pathArray;
+var delimiterSeperatedArray;
 
 /**
- *  creates the folder structure.
+ *  creates a delimiter seperated chain of single keys/values
  *
  *  @param {Object} json
+ *  @param {Object} options
+ *  @param {String} delimiter='/' the delimiter to seperate every single key/value.
  */
 function toPath(_json, options, delimiter) {
-    pathArray = [];
+    delimiterSeperatedArray = [];
 
     if (typeof options === 'string') {
         delimiter = options;
         options = {};
     }
 
-    delimiter = delimiter || '/';
-    options = options || {};
+    delimiter    = delimiter || '/';
+    options      = options || {};
     options.type = options.type || [];
 
     if (!json.check('object', _json)) {
@@ -28,15 +30,15 @@ function toPath(_json, options, delimiter) {
 
     _jsonConcat(_json, options, delimiter);
 
-    return pathArray
+    return delimiterSeperatedArray
 }
 
 /**
- * Make a json file into a path.
+ *  Make a json file into a delimiter seperated string. It will push everything into the global delimiterSeperatedArray
  *
- * @param _json {Objects}
- *
- * @return pathArray
+ *  @param {Object} _json
+ *  @param {Object} options
+ *  @param {String} delimiter='/' the delimiter to seperate every single key/value.
  */
 function _jsonConcat(_json, options, _delimiter, _jsonString) {
     for (var key in _json) {
@@ -58,14 +60,14 @@ function _jsonConcat(_json, options, _delimiter, _jsonString) {
         }
 
         if (options.type.length === 0 || includes(options.type, typeOfString)) {
-            pathArray.push(jsonString);
+            delimiterSeperatedArray.push(jsonString);
         }
 
         if (typeOfString === 'array') {
-            // arrays should iterate over single values and add it to the global pathArray
+            // arrays should iterate over single values and add it to the global delimiterSeperatedArray
             for (var i = 0; i < value.length; i++) {
                 if (options.type.length === 0 || includes(options.type, typeof value[i])) {
-                    pathArray.push(jsonString + _delimiter + value[i])
+                    delimiterSeperatedArray.push(jsonString + _delimiter + value[i])
                 }
             }
         } else if (typeOfString === 'object') {

readme.md

@@ -31,7 +31,9 @@ var json = require('json-extra');
 
 - [check](#check)
 - [isJson](#check)
+- [isValid](#check)
 - [toPath](#toPath)
+- [chain](#toPath)
 - [readToObj](#readToObj)
 - [readToObjSync](#readToObj)
 - [create](#create)
@@ -63,7 +65,11 @@ json.isJson(myJsonString) // true | false
 
 ### toPath()
 
-**toPath(json[, delimiter])**
+**toPath(json[, options][, delimiter])**
+
+Options:
+
+- type (array | string): Get specific types. Available options: `array`, `object`, `string`, `boolean` or `number`
 
 If you want to change your json string into a path just hit this method.
 `base` in an object is always the name of the folder.