Add error info (#29)

* docs: add possible error info

* chore(rel): 3.0.6

README.md

@@ -34,6 +34,8 @@ let path = require('doc-path');
 
 If the key does not exist, `undefined` is returned.
 
+If the object's structure is extremely deep, then an error may be thrown if the maximum call stack size is exceeded while traversing the object.
+
 ##### path.evaluatePath Example:
 
 ```javascript
@@ -87,6 +89,7 @@ console.log(path.evaluatePath(document, 'Features.packages.name'));
 
 If the key does not exist, then the object will be built up to have that path.
 If no document is provided, an error will be thrown.
+If the object's structure is extremely deep, then an error may be thrown if the maximum call stack size is exceeded while traversing the object.
 
 #### path.setPath Example:
 

lib/path.js

@@ -10,6 +10,13 @@ module.exports = {
     setPath
 };
 
+/**
+ * Main function that evaluates the path in a particular object
+ * @param {Object|Array} obj object to evaluate path in
+ * @param {String} kp key path
+ * @returns {*|null} value at key path
+ * @throws {Error} possible error if call stack size is exceeded
+ */
 function evaluatePath(obj, kp) {
     if (!obj) {
         return null;
@@ -46,6 +53,7 @@ function evaluatePath(obj, kp) {
  * @param kp {String} key path
  * @param v {*} value to be set
  * @returns {Object|Array}
+ * @throws {Error} possible error if call stack size is exceeded
  */
 function setPath(obj, kp, v) {
     if (!obj) {

package.json

@@ -2,7 +2,7 @@
     "author": "mrodrig",
     "name": "doc-path",
     "description": "A document path library for Node",
-    "version": "3.0.5",
+    "version": "3.0.6",
     "homepage": "https://mrodrig.github.io/doc-path",
     "repository": {
         "type": "git",