fepper-utils - npm Package Compare versions

Comparing version 1.1.5 to 1.1.6

index.js

@@ -563,7 +563,7 @@ 'use strict';
  * "i" for "inspect". Shorthand for util.inspect or console.dir.
- * This exists primarily for internal debugging. Be sure to remove invocations when done because they won't pass lint.
+ * This exists primarily for internal debugging.
  *
  * @param {object} obj - The object to inspect.
- * @param {null|number} depth - The number of times to recurse while inspecting the object. null means infinity.
- * @param {boolean} showHidden - Whether the object's non-enumerable properties will be included in the result.
+ * @param {null|number} [depth=null] - Number of times to recurse while inspecting the object. `null` means infinity.
+ * @param {boolean} [showHidden=false] - Whether the object's non-enumerable properties will be included in the result.
  */
@@ -570,0 +570,0 @@ exports.i = (obj, depth = null, showHidden = false) => {

package.json

 {
   "name": "fepper-utils",
-  "version": "1.1.5",
+  "version": "1.1.6",
   "description": "Fepper utilities",
@@ -50,5 +50,5 @@ "main": "index.js",
     "eslint": "3.x",
-    "husky": "^1.2.0",
+    "husky": "^1.3.1",
     "jsdoc-to-markdown": "^4.0.1"
   }
 }

README.md

@@ -13,2 +13,3 @@ # Fepper Utilities
 const utils = require('fepper-utils');
+const property = utils.deepGet(obj, 'path.to.nested.property');
 ```
@@ -60,5 +61,5 @@
 </dd>
-<dt><a href="#i">i(obj, depth, showHidden)</a></dt>
+<dt><a href="#i">i(obj, [depth], [showHidden])</a></dt>
 <dd><p>&quot;i&quot; for &quot;inspect&quot;. Shorthand for util.inspect or console.dir.
-This exists primarily for internal debugging. Be sure to remove invocations when done because they won&#39;t pass lint.</p>
+This exists primarily for internal debugging.</p>
 </dd>
@@ -92,3 +93,3 @@ <dt><a href="#info">info()</a></dt>
 
-**Kind**: global function  
+**Kind**: exported function  
 **Returns**: <code>\*</code> \| <code>null</code> - The retrieved data or null on failure.  
@@ -106,3 +107,3 @@
 
-**Kind**: global function  
+**Kind**: exported function  
 **Returns**: <code>object</code> - The mutated obj1 object.  
@@ -120,3 +121,3 @@
 
-**Kind**: global function  
+**Kind**: exported function  
 **Returns**: <code>string</code> - A regular expression with escaped reserved characters.  
@@ -133,3 +134,3 @@
 
-**Kind**: global function  
+**Kind**: exported function  
 **Returns**: <code>array</code> - Shuffled array.  
@@ -151,3 +152,3 @@ **See**
 
-**Kind**: global function  
+**Kind**: exported function  
 **Returns**: <code>string</code> - A valid absolute path to the backend subdirectory, or an empty string.  
@@ -165,3 +166,3 @@
 
-**Kind**: global function  
+**Kind**: exported function  
 **Returns**: <code>string</code> - A normalized file extension, or an empty string if it fails validation.  
@@ -178,3 +179,3 @@
 
-**Kind**: global function  
+**Kind**: exported function  
 **Returns**: <code>string</code> - The absolute path to the found file or an empty string if the search fails.  
@@ -194,3 +195,3 @@
 
-**Kind**: global function  
+**Kind**: exported function  
 **Returns**: <code>string</code> - Path.  
@@ -210,3 +211,3 @@
 
-**Kind**: global function  
+**Kind**: exported function  
 **Returns**: <code>object</code> - The mutated uiObj.  
@@ -227,16 +228,16 @@
 
-**Kind**: global function  
+**Kind**: exported function  
 <a name="i"></a>
 
-## i(obj, depth, showHidden)
+## i(obj, [depth], [showHidden])
 "i" for "inspect". Shorthand for util.inspect or console.dir.
-This exists primarily for internal debugging. Be sure to remove invocations when done because they won't pass lint.
+This exists primarily for internal debugging.
 
-**Kind**: global function  
+**Kind**: exported function  
 
-| Param | Type | Description |
-| --- | --- | --- |
-| obj | <code>object</code> | The object to inspect. |
-| depth | <code>null</code> \| <code>number</code> | The number of times to recurse while inspecting the object. null means infinity. |
-| showHidden | <code>boolean</code> | Whether the object's non-enumerable properties will be included in the result. |
+| Param | Type | Default | Description |
+| --- | --- | --- | --- |
+| obj | <code>object</code> |  | The object to inspect. |
+| [depth] | <code>null</code> \| <code>number</code> | <code>null</code> | Number of times to recurse while inspecting the object. `null` means infinity. |
+| [showHidden] | <code>boolean</code> | <code>false</code> | Whether the object's non-enumerable properties will be included in the result. |
 
@@ -250,3 +251,3 @@ <a name="info"></a>
 
-**Kind**: global function  
+**Kind**: exported function  
 <a name="log"></a>
@@ -258,3 +259,3 @@
 
-**Kind**: global function  
+**Kind**: exported function  
 <a name="warn"></a>
@@ -267,3 +268,3 @@
 
-**Kind**: global function  
+**Kind**: exported function  
 <a name="webservedDirnamesTruncate"></a>
@@ -274,3 +275,3 @@
 
-**Kind**: global function  
+**Kind**: exported function  
 **Returns**: <code>array</code> - The webserved directories stripped of configuration prefix.  
@@ -287,3 +288,3 @@
 
-**Kind**: global function  
+**Kind**: exported function  
 
@@ -290,0 +291,0 @@ | Param | Type | Description |

No alert changes

Improved metrics

Number of lines in readme file

281

increased by0.36%

Worsened metrics

Total package byte prevSize

32620

decreased by-7.52%

Number of package files

4

decreased by-20%

Lines of code

545

decreased by-14.04%

No dependency changes