Function unset

Alias

  • unset(obj, path): boolean

  • Removes the property at the given path of the object.

    Parameters

    • obj: any

      The object to modify.

    • path: PropertyKey | readonly PropertyKey[]

      The path of the property to unset.

    Returns boolean

    • Returns true if the property is deleted, else false.

    Example

    const obj = { a: { b: { c: 42 } } };
    unset(obj, 'a.b.c'); // true
    console.log(obj); // { a: { b: {} } }

    Example

    const obj = { a: { b: { c: 42 } } };
    unset(obj, ['a', 'b', 'c']); // true
    console.log(obj); // { a: { b: {} } }

Settings

Member Visibility