Add custom values support

README.md

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

src/index.js

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

test/src/index.test.js

@@ -64,6 +64,23 @@ describe('cleanDeep()', () => {
     });
   });
 
+  it('should support custom values', () => {
+    const object = {
+      biz: {
+        baz: 123
+      },
+      foo: {
+        bar: 'abc'
+      }
+    };
+
+    expect(cleanDeep(object, { cleanValues: ['abc'] })).toEqual({
+      biz: {
+        baz: 123
+      }
+    });
+  });
+
   it('should include empty objects if `emptyObjects` is `false`', () => {
     const object = {
       biz: {