@feugene/mu/src/object/remove.ts

Helpful TS utilities without dependencies

import isObject from '~/is/isObject'
import { stringToNumber } from '~/to/toNumber'

/**
 * Get value by deep key in object(array)
 *
 * @example
 * const obj = {
        key  : 0,
        label: 'Root',
        items: {
            one: {
                key     : 1,
                label   : 'One',
                val     : 111,
                items   : {
                    two: {
                        key  : 2,
                        label: 'Two',
                        val  : 111,
                        items: {},
                    },
                },
                children: [{
                    key  : 2,
                    label: 'Two',
                    val  : 111,
                    items: {},
                }, {
                    key  : 4,
                    label: 'Four',
                    val  : 444,
                }],
            },
        },
    }

 * remove(obj, 'items.one.children.1.key')
 * remove(obj, 'items.one')
 * remove(obj, 'label')
 * remove(obj, 'items/one/items/two/items','/')
 *
 * @param {object} object
 * @param {string|array} selector
 * @param {string} divider [divider='.']
 * @returns {object}
 */
export default function remove(
  object: Record<PropertyKey, any>,
  selector: string | string[],
  divider: string = '.'
): Record<PropertyKey, any> {
  if (typeof selector === 'string') {
    selector = [selector]
  }

  const removeFromObject = function (from: Record<PropertyKey, any>, keys: string[]): void {
    if (keys.length > 1) {
      if (from[keys[0]] !== undefined) {
        if (Array.isArray(from[keys[0]]) || isObject(from[keys[0]])) {
          removeFromObject(from[keys[0]], keys.slice(1))
        }
      }
    } else {
      if (Array.isArray(from)) {
        from.splice(stringToNumber(keys[0]), 1)
      } else if (isObject(from)) {
        delete from[keys[0]]
      }
    }
  }

  if (Array.isArray(selector)) {
    selector.forEach(v => {
      removeFromObject(object, v.split(divider))
    })
  }

  return object
}