@aofl/object-utils - npm Package Compare versions

Comparing version 3.12.1 to 3.13.0

package.json

 {
   "name": "@aofl/object-utils",
-  "version": "3.12.1",
+  "version": "3.13.0",
   "description": "A small collection of Object utility functions designed to have a small footprint (20b gz) and be performant",
@@ -35,3 +35,3 @@ "main": "index.js",
   "devDependencies": {
-    "@aofl/cli": "^3.12.1",
+    "@aofl/cli": "^3.13.0",
     "cross-env": "^6.0.3",
@@ -38,0 +38,0 @@ "jsdoc": "^3.6.3",

types.d.ts

 /**
  * Exports deepAssign, deepFreeze, get, has, set, defaults, recurseObjectByPath
- *
- * @module @aofl/object-utils
- * @version 3.0.0
- * @since 1.0.0
- * @author Arian Khosravi <[e-mail]>
  */
@@ -13,8 +8,4 @@ declare module "@aofl/object-utils" {
      * properties by a given path.
-     *
-     * @memberof module:@aofl/object-utils
-     *
-     * @param {Object} obj
-     * @param {String} path dot notatino
-     * @param {Function} op operation to perform as object is recursed by path.
+     * @param path - dot notatino
+     * @param op - operation to perform as object is recursed by path.
      */
@@ -24,4 +15,2 @@ function recurseObjectByPath(obj: any, path: string, op: (...params: any[]) => any): void;
      * Recursively calls Object.assign along the specified path.
-     *
-     * @memberof module:@aofl/object-utils
      * @example
@@ -60,6 +49,5 @@ * let user = {
      * };
-     * @param {Object} left left source
-     * @param {String} path path to target
-     * @param {Object} right right source
-     * @return {Object}
+     * @param left - left source
+     * @param path - path to target
+     * @param right - right source
      */
@@ -69,7 +57,2 @@ function deepAssign(left: any, path: string, right: any): any;
      * Recursively calls Object.freeze on objects properties
-     *
-     * @memberof module:@aofl/object-utils
-     *
-     * @param {Object} source
-     * @return {Object}
      */
@@ -79,9 +62,2 @@ function deepFreeze(source: any): any;
      * Assigns missing defaultOptions onto the target object.
-     *
-     * @memberof module:@aofl/object-utils
-     *
-     * @param {Object} target
-     * @param {Object} defaultOptions
-     *
-     * @return {Object}
      */
@@ -91,7 +67,3 @@ function defaults(target: any, defaultOptions: any): any;
      * Returns nested property of an object based on path.
-     *
-     * @memberof module:@aofl/object-utils
-     *
-     * @param {Object} obj
-     * @param {String} path dot notation
+     * @param path - dot notation
      */
@@ -101,8 +73,3 @@ function get(obj: any, path: string): void;
      * Checks if an object has a nested property defined by path.
-     *
-     * @memberof module:@aofl/object-utils
-     *
-     * @param {Object} obj
-     * @param {String} path dot notation
-     * @retrun {Boolean}
+     * @param path - dot notation
      */
@@ -112,7 +79,2 @@ function has(obj: any, path: string): void;
      * Sets the value of a nested member of an object.
-     *
-     * @memberof module:@aofl/object-utils
-     * @param {Object} obj
-     * @param {String} path
-     * @param {*} val
      */
@@ -119,0 +81,0 @@ function set(obj: any, path: string, val: any): void;

No alert changes

Worsened metrics

Total package byte prevSize

28055

-3.16%

Lines of code

350

-9.79%

No dependency changes