add cleanKeys option

README.md

@@ -25,6 +25,7 @@ $ npm install clean-deep --save
 
 Option            | Default value | Description
 ----------------- | ------------- | -----------------------------------
+_cleanKeys_       | _[]_          | Remove specific keys, ie: `['foo', 'bar', ' ']`
 _cleanValues_     | _[]_          | Remove specific values, ie: `['foo', 'bar', ' ']`
 _emptyArrays_     | _true_        | Remove empty arrays, ie: `[]`
 _emptyObjects_    | _true_        | Remove empty objects, ie: `{}`

src/index.js

@@ -12,6 +12,7 @@ const transform = require('lodash.transform');
  */
 
 module.exports = function cleanDeep(object, {
+  cleanKeys = [],
   cleanValues = [],
   emptyArrays = true,
   emptyObjects = true,
@@ -20,9 +21,14 @@ module.exports = function cleanDeep(object, {
   undefinedValues = true
 } = {}) {
   return transform(object, (result, value, key) => {
+    // Exclude specific keys.
+    if (cleanKeys.includes(key)) {
+      return;
+    }
+
     // Recurse into arrays and objects.
     if (Array.isArray(value) || isPlainObject(value)) {
-      value = cleanDeep(value, { cleanValues, emptyArrays, emptyObjects, emptyStrings, nullValues, undefinedValues });
+      value = cleanDeep(value, { cleanKeys, cleanValues, emptyArrays, emptyObjects, emptyStrings, nullValues, undefinedValues });
     }
 
     // Exclude specific values.

test/src/index.test.js

@@ -175,4 +175,30 @@ describe('cleanDeep()', () => {
       }
     });
   });
+
+  it('should remove specified keys if `cleanKeys` is passed', () => {
+    const object = {
+      foo: {
+        alsoMe: {
+          biz: 123,
+        },
+        bar: undefined,
+        biz: 123,
+        qux: [
+          undefined,
+          {},
+          true
+        ],
+        removeMe: true,
+      },
+      removeMe: true,
+    };
+
+    expect(cleanDeep(object, { cleanKeys: ['removeMe', 'alsoMe'] })).toEqual({
+      foo: {
+        biz: 123,
+        qux: [true]
+      }
+    });
+  });
 });