Function unset

  • unset(object, path): boolean

  • Removes the property at path of object.

    Note: This method mutates object.

    Parameters

    • object: object

      The object to modify.

    • path: PropertyPath

      The path of the property to unset.

    Returns boolean

    Returns true if the property is deleted, else false.

    Since

    4.0.0

    See

    get, has, set

    Example

    const object = { 'a': [{ 'b': { 'c': 7 } }] }
    unset(object, 'a[0].b.c')
    // => true

    console.log(object)
    // => { 'a': [{ 'b': {} }] }

    unset(object, ['a', '0', 'b', 'c'])
    // => true

    console.log(object)
    // => { 'a': [{ 'b': {} }] }

Settings

Member Visibility