Skip to content

Instantly share code, notes, and snippets.

@aurbano
Last active November 29, 2022 21:57
Show Gist options
  • Save aurbano/383e691368780e7f5c98 to your computer and use it in GitHub Desktop.
Save aurbano/383e691368780e7f5c98 to your computer and use it in GitHub Desktop.
Remove a property from a nested object, recursively
/**
* Remove all specified keys from an object, no matter how deep they are.
* The removal is done in place, so run it on a copy if you don't want to modify the original object.
* This function has no limit so circular objects will probably crash the browser
*
* @param obj The object from where you want to remove the keys
* @param keys An array of property names (strings) to remove
*/
function removeKeys(obj, keys){
var index;
for (var prop in obj) {
// important check that this is objects own property
// not from prototype prop inherited
if(obj.hasOwnProperty(prop)){
switch(typeof(obj[prop])){
case 'string':
index = keys.indexOf(prop);
if(index > -1){
delete obj[prop];
}
break;
case 'object':
index = keys.indexOf(prop);
if(index > -1){
delete obj[prop];
}else{
removeKeys(obj[prop], keys);
}
break;
}
}
}
}
@hanishi
Copy link

hanishi commented Jun 1, 2019

Here is a variant of yours.

const obj = {'a': {'b': {'c': {'a': 1}, 'B':1}, 'd':{'e':1, 'a':1}},'c':123}
const key = 'a.b.c';
removeKey(obj, key.split('.'))
will give you the result of
'{"a":{"b":{"B":1},"d":{"e":1,"a":1}},"c":123}'
could be useful if you want to remove a property that is at the specific location.

removeKey(obj, keys: Array<string>) {
    const [head, ...tail] = keys;
    for (const prop in obj) {
      obj.hasOwnProperty(prop) && (head === prop && tail.length === 0 ?
        delete obj[prop] : 'object' === typeof (obj[prop]) && (this.removeKey(obj[prop], tail),
      0 === Object.keys(obj[prop]).length && delete obj[prop]))
    }
  }

@earle
Copy link

earle commented Nov 1, 2019

That will only remove nested Strings or Objects from objects...

> obj = { deleteme: true }
{ deleteme: true }
> removeKeys(obj, 'deleteme')
undefined
> obj
{ deleteme: true }

What you may want is:

function removeKeys(obj, keys) {
    for (var prop in obj) {
        if(obj.hasOwnProperty(prop)) {
            switch(typeof(obj[prop])) {
                case 'object':
                    if(keys.indexOf(prop) > -1) {
                        delete obj[prop];
                    } else {
                        removeKeys(obj[prop], keys);
                    }
                    break;
              default:
                    if(keys.indexOf(prop) > -1) {
                        delete obj[prop];
                    }
                    break;
            }
        }
    }
}

@tevin-morake
Copy link

tevin-morake commented Jun 25, 2020

Hmm.. I want to remove all circular references in an object 😞 . I thought it was possible 🥇

@mac2000
Copy link

mac2000 commented Nov 15, 2020

Just for future reference

const removeKey = (obj, key) => obj !== Object(obj)
    ? obj
    : Array.isArray(obj)
        ? obj.map(item => removeKey(item, key))
        : Object.keys(obj)
            .filter(k => k !== key)
            .reduce((acc, x) => Object.assign(acc, { [x]: removeKey(obj[x], key) }), {});

@JUNNNI
Copy link

JUNNNI commented Dec 14, 2020

Thanks @mac2000 I would just changed it to have multiple keys, with an includes check :

const removeKeys = (obj, keys) => obj !== Object(obj)
      ? obj
      : Array.isArray(obj)
      ? obj.map((item) => removeKeys(item, keys))
      : Object.keys(obj)
          .filter((k) => !keys.includes(k))
          .reduce(
            (acc, x) => Object.assign(acc, { [x]: removeKeys(obj[x], keys) }),
            {}
          )

@gaurangrshah
Copy link

Hey everyone, I recently put this together using the example above. Admittedly, I personally have trouble following .reduce's logic from time to time, so it helps to distill it down for myself. Wanted to check with you guys to see if you see anything wrong with my logic:

const removeKeys = (obj, keys) => obj !== Object(obj)
      ? obj
      : Array.isArray(obj)
      ? obj.map((item) => removeKeys(item, keys))
      : Object.fromEntries(Object.entries(obj).filter(([k]) => !keys.includes(k)));

@johnrails
Copy link

@mac2000 that's a nice solution except for every object you remove it is replaced with an empty object, so if i have an array of objects, and i want to remove one of them from the array it is replaced with an empty object.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment