remove-anything 2.0.2 → 2.1.0

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`, empty objects, ...) from an object. A small and simple integration.
+An optimised way to remove any prop value (eg. `undefined`, empty objects, ...) from an object. A small and simple integration.
 
 ## Usage
 

package/dist/index.d.ts

@@ -1,20 +1,20 @@
-/**
- * Recursively remove props from an object, if the prop's value matches `valueToRemove`
- */
+/** Recursively remove props from an object, if the prop's value matches `valueToRemove` */
 export declare function removeProp(payload: {
     [key in string | number | symbol]: unknown;
 }, valueToRemove: unknown, ...valuesToRemove: unknown[]): {
     [key in string | number | symbol]: unknown;
 };
 /**
- * @deprecated use `removeProp` instead and pass multiple parameters
+ * Recursively remove props from an object, if the prop's value matches `valueToRemove`
+ *
+ * This function mutates the passed object in place and returns void.
  */
-export declare const removeProps: (payload: {
-    [x: string]: unknown;
-    [x: number]: unknown;
-    [x: symbol]: unknown;
-}, valuesToRemove: unknown[]) => {
-    [x: string]: unknown;
-    [x: number]: unknown;
-    [x: symbol]: unknown;
+export declare function removePropInPlace(payload: {
+    [key in string | number | symbol]: unknown;
+}, valueToRemove: unknown, ...valuesToRemove: unknown[]): void;
+/** @deprecated Use `removeProp` instead and pass multiple parameters */
+export declare function removeProps(payload: {
+    [key in string | number | symbol]: unknown;
+}, valuesToRemove: unknown[]): {
+    [key in string | number | symbol]: unknown;
 };

package/dist/index.js

@@ -1,7 +1,6 @@
+/* eslint-disable @typescript-eslint/no-dynamic-delete */
 import { isEmptyArray, isEmptyObject, isPlainObject } from 'is-what';
-/**
- * Recursively remove props from an object, if the prop's value matches `valueToRemove`
- */
+/** Recursively remove props from an object, if the prop's value matches `valueToRemove` */
 export function removeProp(payload, valueToRemove, ...valuesToRemove) {
     if (!isPlainObject(payload))
         return payload;
@@ -15,6 +14,7 @@ export function removeProp(payload, valueToRemove, ...valuesToRemove) {
             return carry;
         if (remove.includes(value))
             return carry;
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
         const newVal = removeProp(value, remove[0], ...remove.slice(1));
         if (removeEmptyObjects && isEmptyObject(newVal))
             return carry;
@@ -25,6 +25,43 @@ export function removeProp(payload, valueToRemove, ...valuesToRemove) {
     }, {});
 }
 /**
- * @deprecated use `removeProp` instead and pass multiple parameters
+ * Recursively remove props from an object, if the prop's value matches `valueToRemove`
+ *
+ * This function mutates the passed object in place and returns void.
  */
-export const removeProps = (payload, valuesToRemove) => removeProp(payload, valuesToRemove[0], ...valuesToRemove);
+export function removePropInPlace(payload, valueToRemove, ...valuesToRemove) {
+    if (!isPlainObject(payload))
+        return;
+    const remove = [valueToRemove, ...valuesToRemove];
+    const removeEmptyObjects = !!remove.find((val) => isEmptyObject(val));
+    const removeEmptyArrays = !!remove.find((val) => isEmptyArray(val));
+    Object.entries(payload).forEach(([key, value]) => {
+        if (removeEmptyObjects && isEmptyObject(value)) {
+            delete payload[key];
+            return;
+        }
+        if (removeEmptyArrays && isEmptyArray(value)) {
+            delete payload[key];
+            return;
+        }
+        if (remove.includes(value)) {
+            delete payload[key];
+            return;
+        }
+        if (value && isPlainObject(value)) {
+            removePropInPlace(value, remove[0], ...remove.slice(1));
+        }
+        if (removeEmptyObjects && isEmptyObject(value)) {
+            delete payload[key];
+            return;
+        }
+        if (removeEmptyArrays && isEmptyArray(value)) {
+            delete payload[key];
+            return;
+        }
+    });
+}
+/** @deprecated Use `removeProp` instead and pass multiple parameters */
+export function removeProps(payload, valuesToRemove) {
+    return removeProp(payload, valuesToRemove[0], ...valuesToRemove);
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "remove-anything",
-  "version": "2.0.2",
+  "version": "2.1.0",
   "description": "Remove any prop (eg. `undefined`) from an object",
   "type": "module",
   "sideEffects": false,
@@ -17,14 +17,14 @@
     "release": "npm run lint && npm run build && np"
   },
   "dependencies": {
-    "is-what": "^5.0.1"
+    "is-what": "^5.2.1"
   },
   "devDependencies": {
-    "del-cli": "^5.1.0",
-    "np": "^10.0.5",
-    "vitest": "^1.6.0",
-    "@cycraft/eslint": "^0.3.0",
-    "@cycraft/tsconfig": "^0.1.2"
+    "@cycraft/eslint": "^0.4.4",
+    "@cycraft/tsconfig": "^0.1.2",
+    "del-cli": "^6.0.0",
+    "np": "^10.2.0",
+    "vitest": "^3.2.4"
   },
   "files": [
     "dist"