remove-anything 2.0.3 → 2.1.1

package/README.md

@@ -49,6 +49,17 @@ removeProps(payload, {}, [])
 // { a: 1, b: undefined }
 ```
 
+### In-Place Mutation
+
+Use `removePropInPlace` to mutate the original object instead of creating a new one:
+
+```js
+const payload = { a: 1, b: undefined, c: {} }
+removePropInPlace(payload, undefined, {})
+
+// payload is now mutated to: { a: 1 }
+```
+
 ## Meet the family (more tiny utils with TS support)
 
 - [is-what 🙉](https://github.com/mesqueeb/is-what)

package/dist/index.d.ts

@@ -4,6 +4,14 @@ export declare function removeProp(payload: {
 }, valueToRemove: unknown, ...valuesToRemove: unknown[]): {
     [key in string | number | symbol]: unknown;
 };
+/**
+ * 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 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;

package/dist/index.js

@@ -1,3 +1,4 @@
+/* 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` */
 export function removeProp(payload, valueToRemove, ...valuesToRemove) {
@@ -13,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;
@@ -22,6 +24,43 @@ export function removeProp(payload, valueToRemove, ...valuesToRemove) {
         return carry;
     }, {});
 }
+/**
+ * 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 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.3",
+  "version": "2.1.1",
   "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.2.0"
+    "is-what": "^5.2.1"
   },
   "devDependencies": {
-    "@cycraft/eslint": "^0.4.3",
+    "@cycraft/eslint": "^0.4.4",
     "@cycraft/tsconfig": "^0.1.2",
     "del-cli": "^6.0.0",
     "np": "^10.2.0",
-    "vitest": "^3.0.6"
+    "vitest": "^3.2.4"
   },
   "files": [
     "dist"