added is object fn, updated clean object fn

Author: oleg-yasenytsky

README.md

@@ -15,14 +15,12 @@ yarn add @idapgroup/js-object-utils
 
 ## Usage
 
-### createFormData
-
-Serialize object to FormData instance.
+### isObject
 
-[DEMO](https://stackblitz.com/edit/typescript-br9t3k?file=index.ts)
+Detect is object created by the `Object` constructor
 
 ```js
-import { createFormData } from '@idapgroup/js-object-utils';
+import { isObject } from '@idapgroup/js-object-utils';
 
 const object = {
   /**
@@ -31,36 +29,61 @@ const object = {
    */
 };
 
-const options = {
-  /**
-   * prefix for form data key
-   * defaults empty string
-   */
-  keyPrefix: '',
+const isObj = isObject(object) // true of false;
+```
 
-  /**
-   * prefix index for form data key
-   * defaults to null
-   */
-  index: null,
+### createFormData
 
-  /**
-   * callback fn for convert true or false
-   * defaults true or false to '1' or '0' respectively
-   */
-  booleanMapper: (val: boolean) => (val ? '1' : '0'),
+Serialize object to FormData instance.
 
-  /**
-   * allow empty string or array
-   * defaults to false
-   */
-  allowEmptyValues: false,
+[DEMO](https://stackblitz.com/edit/typescript-br9t3k?file=index.ts)
+
+<details>
+  <summary>Options</summary>
+
+  ```js
+  const options = {
+    /**
+     * prefix for form data key
+     * defaults empty string
+     */
+    keyPrefix: '',
+  
+    /**
+     * prefix index for form data key
+     * defaults to null
+     */
+    index: null,
+  
+    /**
+     * callback fn for convert true or false
+     * defaults true or false to '1' or '0' respectively
+     */
+    booleanMapper: (val: boolean) => (val ? '1' : '0'),
 
+    /**
+     * allow empty string or array
+     * defaults to false
+     */
+    allowEmptyValues: false,
+    
+    /**
+     * allow nullable values, ignore if emptyValues not allow 
+     * defaults to false
+     */
+    allowNullableValues: false,
+  };
+  ```
+</details>
+
+```js
+import { createFormData } from '@idapgroup/js-object-utils';
+
+const object = {
   /**
-   * allow nullable values, ignore if emptyValues not allow 
-   * defaults to false
+   * key-value mapping
+   * values can be primitives or objects
    */
-  allowNullableValues: false,
 };
 
 const formData = createFormData(
@@ -76,6 +99,39 @@ Serialize object to object with key and primitive value.
 
 [DEMO](https://stackblitz.com/edit/typescript-1tpwga?file=index.ts)
 
+<details>
+  <summary>Options</summary>
+
+  ```js
+  const options = {
+    /**
+     * prefix for form data key
+     * defaults empty string
+     */
+    keyPrefix: '',
+  
+    /**
+     * prefix index for form data key
+     * defaults to null
+     */
+    index: null,
+  
+    /**
+     * prefix index for form data key
+     * defaults to null
+     */
+    toString: null,
+  
+    /**
+     * callback fn for convert true or false
+     * defaults true or false to '1' or '0' respectively
+     */
+    booleanMapper: (val: boolean) => (val ? '1' : '0'),
+  };
+  ```
+
+</details>
+
 ```js
 import { createURLParams } from '@idapgroup/js-object-utils';
 
@@ -86,34 +142,43 @@ const object = {
    */
 };
 
-const options = {
-  /**
-   * prefix for form data key
-   * defaults empty string
-   */
-  keyPrefix: '',
+const params = createURLParams(
+  object,
+  options, // optional
+);
+```
 
-  /**
-   * prefix index for form data key
-   * defaults to null
-   */
-  index: null,
 
-  /**
-   * prefix index for form data key
-   * defaults to null
-   */
-  toString: null,
+### cleanObject
+
+Remove nullable/empty values in object
 
+<details>
+  <summary>Options</summary>
+
+  ```js
+  const options = {
+    /**
+     * remove empty string, object, array in object
+     * defaults false
+     */
+    removeEmptyValues: false,
+  };
+  ```
+</details>
+
+```js
+import { cleanObject } from '@idapgroup/js-object-utils';
+
+const object = {
   /**
-   * callback fn for convert true or false
-   * defaults true or false to '1' or '0' respectively
+   * key-value mapping
+   * values can be primitives or objects
    */
-  booleanMapper: (val: boolean) => (val ? '1' : '0'),
 };
 
-const params = createURLParams(
-  object,
+const obj = cleanObject(
+  object, 
   options, // optional
 );
 ```

package.json

@@ -11,7 +11,7 @@
   },
   "license": "MIT",
   "scripts": {
-    "build": "rm -rf build/ && run-p build:*",
+    "build": "rimraf build/ && run-p build:*",
     "build:main": "tsc -p tsconfig.json",
     "build:module": "tsc -p tsconfig.module.json",
     "fix": "run-s fix:*",
@@ -46,6 +46,7 @@
     "npm-run-all": "^4.1.5",
     "nyc": "^15.1.0",
     "prettier": "^2.8.3",
+    "rimraf": "^4.1.2",
     "ts-node": "^10.9.1",
     "typescript": "^4.9.4"
   },
@@ -66,7 +67,9 @@
     "formData",
     "object to formData",
     "object to url params",
-    "url params"
+    "url params",
+    "is object",
+    "clean object"
   ],
   "author": "idapgroup"
 }

src/index.ts

@@ -1,6 +1,7 @@
 export { createURLParams } from './lib/create-url-params';
 export { createFormData } from './lib/create-form-data';
 export { cleanObject } from './lib/clean-object';
+export { isObject } from './lib/is-object';
 export * from './types/create-url-params';
 export * from './types/create-form-data';
 export * from './types/clean-object';

src/lib/clean-object.ts

@@ -1,33 +1,41 @@
-import { CleanObjectConfig, Record } from '../types/clean-object';
+import { CleanObjectConfig } from '../types/clean-object';
+
+import { isObject } from './is-object';
 
 const defaultConfig: CleanObjectConfig = {
   removeEmptyValues: false,
 };
 
+const isEmptyObject = (o: object) => Object.keys(o).length === 0;
+
 const needSkipValue = (
   value: unknown,
   { removeEmptyValues }: CleanObjectConfig
 ): boolean => {
   if (value === null || value === undefined) {
     return true;
   }
-  if (typeof value !== 'string') {
-    return false;
+  if (removeEmptyValues) {
+    if (Array.isArray(value)) {
+      return value.length === 0;
+    }
+    if (typeof value === 'string') {
+      return !value;
+    }
+    if (isObject(value) && isEmptyObject(value)) {
+      return true;
+    }
   }
-  return value === '' && removeEmptyValues;
+  return false;
 };
 
-export const cleanObject = (
-  obj: Record,
+export const cleanObject = <T extends object>(
+  obj: T,
   config?: Partial<CleanObjectConfig>
-): Record => {
+): object => {
   const cfg = Object.assign({ ...defaultConfig }, config || {});
 
-  if (obj === null || obj === undefined) {
-    return {};
-  }
-
-  if (obj instanceof Blob || obj instanceof File || obj instanceof Date) {
+  if (!isObject(obj)) {
     return obj;
   }
 
@@ -39,22 +47,22 @@ export const cleanObject = (
 
   const keys = Object.keys(obj);
   if (!keys.length) {
-    return {};
+    return obj;
   }
 
-  return keys.reduce((acc: Record, key) => {
-    const item = obj[key];
+  return keys.reduce((acc: object, key) => {
+    const item = obj[key as keyof T];
     if (needSkipValue(item, cfg)) {
       return acc;
     }
     if (Array.isArray(item)) {
       if (!item.length && cfg.removeEmptyValues) {
         return acc;
       }
-      const mapped = item.reduce((arr: Record[], curr) => {
-        if (typeof curr === 'object' && curr) {
+      const mapped = item.reduce((arr: object[], curr) => {
+        if (isObject(curr)) {
           const cleared = cleanObject(curr, cfg);
-          if (!Object.keys(cleared).length && cfg.removeEmptyValues) {
+          if (isEmptyObject(cleared) && cfg.removeEmptyValues) {
             return arr;
           }
           return [...arr, cleared];
@@ -65,9 +73,9 @@ export const cleanObject = (
       return { ...acc, [`${key}`]: mapped };
     }
 
-    if (typeof item === 'object' && item) {
-      const mapped = cleanObject(item as Record, cfg);
-      if (!Object.keys(mapped).length && cfg.removeEmptyValues) {
+    if (item && typeof item === 'object' && isObject(item)) {
+      const mapped = cleanObject(item, cfg);
+      if (isEmptyObject(mapped) && cfg.removeEmptyValues) {
         return acc;
       }
       return { ...acc, [`${key}`]: mapped };

src/lib/is-object.ts

@@ -0,0 +1,2 @@
+export const isObject = (o: object): boolean =>
+  Object.prototype.toString.call(o) === '[object Object]';

src/types/clean-object.ts

@@ -1,7 +1,3 @@
-export interface Record {
-  [key: string]: unknown;
-}
-
 export interface CleanObjectConfig {
   removeEmptyValues: boolean;
 }

test/clean-object.spec.ts

@@ -9,10 +9,12 @@ use(deepEqualInAnyOrder);
 describe('cleanObject function', () => {
   it('should be success for simple values', () => {
     expect(cleanObject({})).to.deep.equal({});
-    expect(cleanObject(null)).to.deep.equal({});
+    expect(cleanObject(null)).to.deep.equal(null);
     const date = new Date();
     expect(cleanObject(date)).to.deep.equal(date);
     expect(cleanObject([])).to.deep.equal([]);
+    const str = new String('test');
+    expect(cleanObject(str)).to.deep.equal(str);
   });
 
   it('should be success for nullable values obj', () => {
@@ -27,7 +29,7 @@ describe('cleanObject function', () => {
         active: false,
         status: null,
         file,
-        previous: [],
+        previous: [[]],
         obj: {},
       },
       file,
@@ -41,7 +43,7 @@ describe('cleanObject function', () => {
       subscription: {
         active: false,
         file,
-        previous: [],
+        previous: [[]],
         obj: {},
       },
       file,
@@ -50,7 +52,7 @@ describe('cleanObject function', () => {
     };
     expect(cleanObject(obj)).to.deep.equal(expectedResult);
   });
-  it('should be success for empty string and array in obj', () => {
+  it('should be success with removeEmptyValues option', () => {
     const obj = {
       id: 1,
       name: 'test',