remove-anything 1.0.1 → 1.0.3

package/README.md

@@ -9,7 +9,7 @@ npm i remove-anything
 
 Removes props (eg. undefined) from an object
 
-An optimised way to remove any prop (eg. `undefined`) from an object. A small and simple integration.
+An optimised way to remove any prop (eg. `undefined`, empty objects, ...) from an object. A small and simple integration.
 
 ## Usage
 
@@ -27,6 +27,28 @@ const no1 = removeProp(payload, 1)
 no1 // { b: undefined }
 ```
 
+### Remove multiple props
+
+You can keep on passing parameters to remove additional props
+
+```js
+const payload = { a: 1, b: undefined }
+removeProp(payload, 1, undefined)
+
+// returns
+// { a: 1 }
+```
+
+### Remove Empty Objects and Arrays
+
+```js
+const payload = { a: 1, b: undefined, c: {}, d: [] }
+removeProps(payload, {}, [])
+
+// returns
+// { a: 1, b: undefined }
+```
+
 ## Meet the family
 
 - [copy-anything 🎭](https://github.com/mesqueeb/copy-anything)
@@ -36,4 +58,3 @@ no1 // { b: undefined }
 - [compare-anything 🛰](https://github.com/mesqueeb/compare-anything)
 - [flatten-anything 🏏](https://github.com/mesqueeb/flatten-anything)
 - [is-what 🙉](https://github.com/mesqueeb/is-what)
-

package/dist/index.cjs

@@ -1,34 +1,36 @@
 'use strict';
 
-Object.defineProperty(exports, '__esModule', { value: true });
-
 var isWhat = require('is-what');
 
 /**
- * Recursively remove props from an object, if the prop's value matches any of those in `valuesToRemove`
+ * Recursively remove props from an object, if the prop's value matches `valueToRemove`
  */
-function removeProps(payload, valuesToRemove = []) {
-    if (!isWhat.isPlainObject(payload) || !isWhat.isFullArray(valuesToRemove))
+function removeProp(payload, valueToRemove, ...valuesToRemove) {
+    if (!isWhat.isPlainObject(payload))
         return payload;
-    const removeEmptyObjects = !!valuesToRemove.find((val) => isWhat.isEmptyObject(val));
+    const remove = [valueToRemove, ...valuesToRemove];
+    const removeEmptyObjects = !!remove.find((val) => isWhat.isEmptyObject(val));
+    const removeEmptyArrays = !!remove.find((val) => isWhat.isEmptyArray(val));
     return Object.entries(payload).reduce((carry, [key, value]) => {
         if (removeEmptyObjects && isWhat.isEmptyObject(value))
             return carry;
-        if (valuesToRemove.includes(value))
+        if (removeEmptyArrays && isWhat.isEmptyArray(value))
+            return carry;
+        if (remove.includes(value))
             return carry;
-        const newVal = removeProps(value, valuesToRemove);
+        const newVal = removeProp(value, remove[0], ...remove.slice(1));
         if (removeEmptyObjects && isWhat.isEmptyObject(newVal))
             return carry;
+        if (removeEmptyArrays && isWhat.isEmptyArray(newVal))
+            return carry;
         carry[key] = newVal;
         return carry;
     }, {});
 }
 /**
- * Recursively remove props from an object, if the prop's value matches `valueToRemove`
+ * @deprecated use `removeProp` instead and pass multiple parameters
  */
-function removeProp(payload, valueToRemove) {
-    return removeProps(payload, [valueToRemove]);
-}
+const removeProps = (payload, valuesToRemove) => removeProp(payload, valuesToRemove[0], ...valuesToRemove);
 
 exports.removeProp = removeProp;
 exports.removeProps = removeProps;

package/dist/index.es.js

@@ -1,29 +1,33 @@
-import { isPlainObject, isFullArray, isEmptyObject } from 'is-what';
+import { isPlainObject, isEmptyObject, isEmptyArray } from 'is-what';
 
 /**
- * Recursively remove props from an object, if the prop's value matches any of those in `valuesToRemove`
+ * Recursively remove props from an object, if the prop's value matches `valueToRemove`
  */
-function removeProps(payload, valuesToRemove = []) {
-    if (!isPlainObject(payload) || !isFullArray(valuesToRemove))
+function removeProp(payload, valueToRemove, ...valuesToRemove) {
+    if (!isPlainObject(payload))
         return payload;
-    const removeEmptyObjects = !!valuesToRemove.find((val) => isEmptyObject(val));
+    const remove = [valueToRemove, ...valuesToRemove];
+    const removeEmptyObjects = !!remove.find((val) => isEmptyObject(val));
+    const removeEmptyArrays = !!remove.find((val) => isEmptyArray(val));
     return Object.entries(payload).reduce((carry, [key, value]) => {
         if (removeEmptyObjects && isEmptyObject(value))
             return carry;
-        if (valuesToRemove.includes(value))
+        if (removeEmptyArrays && isEmptyArray(value))
+            return carry;
+        if (remove.includes(value))
             return carry;
-        const newVal = removeProps(value, valuesToRemove);
+        const newVal = removeProp(value, remove[0], ...remove.slice(1));
         if (removeEmptyObjects && isEmptyObject(newVal))
             return carry;
+        if (removeEmptyArrays && isEmptyArray(newVal))
+            return carry;
         carry[key] = newVal;
         return carry;
     }, {});
 }
 /**
- * Recursively remove props from an object, if the prop's value matches `valueToRemove`
+ * @deprecated use `removeProp` instead and pass multiple parameters
  */
-function removeProp(payload, valueToRemove) {
-    return removeProps(payload, [valueToRemove]);
-}
+const removeProps = (payload, valuesToRemove) => removeProp(payload, valuesToRemove[0], ...valuesToRemove);
 
 export { removeProp, removeProps };

package/dist/types/index.d.ts

@@ -1,5 +1,8 @@
 /**
- * Recursively remove props from an object, if the prop's value matches any of those in `valuesToRemove`
+ * Recursively remove props from an object, if the prop's value matches `valueToRemove`
  */
-export declare function removeProps(payload: Record<string, any>, valuesToRemove?: any[]): Record<string, unknown>;
-export declare function removeProp<Payload extends Record<string, any>>(payload: Payload, valueToRemove: any): Payload;
+export declare function removeProp(payload: Record<string, any>, valueToRemove: any, ...valuesToRemove: any[]): Record<string, unknown>;
+/**
+ * @deprecated use `removeProp` instead and pass multiple parameters
+ */
+export declare const removeProps: (payload: Record<string, any>, valuesToRemove: any[]) => Record<string, unknown>;

package/package.json

@@ -2,7 +2,7 @@
   "name": "remove-anything",
   "sideEffects": false,
   "type": "module",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "description": "Remove any prop (eg. `undefined`) from an object",
   "module": "./dist/index.es.js",
   "main": "./dist/index.cjs",
@@ -23,25 +23,25 @@
   "scripts": {
     "test": "vitest run",
     "lint": "tsc --noEmit && eslint ./src --ext .ts",
-    "build": "rollup -c ./scripts/build.js",
+    "build": "rollup -c=./scripts/build.js --bundleConfigAsCjs",
     "release": "npm run lint && del dist && npm run build && np"
   },
   "dependencies": {
-    "is-what": "^4.1.1"
+    "is-what": "^4.1.7"
   },
   "devDependencies": {
-    "@typescript-eslint/eslint-plugin": "^5.10.1",
-    "@typescript-eslint/parser": "^5.10.1",
-    "del-cli": "^4.0.1",
-    "eslint": "^8.7.0",
-    "eslint-config-prettier": "^8.3.0",
+    "@typescript-eslint/eslint-plugin": "^5.40.1",
+    "@typescript-eslint/parser": "^5.40.1",
+    "del-cli": "^5.0.0",
+    "eslint": "^8.26.0",
+    "eslint-config-prettier": "^8.5.0",
     "eslint-plugin-tree-shaking": "^1.10.0",
-    "np": "^7.6.0",
-    "prettier": "^2.5.1",
-    "rollup": "^2.66.0",
-    "rollup-plugin-typescript2": "^0.31.1",
-    "typescript": "^4.5.5",
-    "vitest": "^0.2.1"
+    "np": "^7.6.2",
+    "prettier": "^2.7.1",
+    "rollup": "^3.2.3",
+    "rollup-plugin-typescript2": "^0.34.1",
+    "typescript": "^4.8.4",
+    "vitest": "^0.24.3"
   },
   "keywords": [
     "remove",