Removes the property at path of object. Mutates in place. Returns true if the property is deleted, else false. Part of Lodash 4.x Object (since 4.0.0).
Pass the object and path or keys shown below. Check whether the helper mutates or returns a new object.
Call _.unset. Start with this line.
_.unset(object, path)| Call | What it does |
|---|---|
_.unset(object, path) | Primary signature. |
_.unset(object) | Work with an object’s keys, values, or paths. |
Prefer import unset from "lodash/unset" when you want a smaller bundle.
_.unset(object, path)| Parameter | Description |
|---|---|
| object | Required. Target object (mutated) |
| path | Required. Dot/bracket string or key array |
| Return Value | Description |
|---|---|
| * | true / false |
Remove a deep property with bracket/dot notation.
var object = { a: [{ b: { c: 7 } }] };
_.unset(object, "a[0].b.c");
// → true
object;
// → { a: [{ b: {} }] }"a[0].b.c" becomes path segments.{ c: 7 }.c in place.b remains as an empty object.Same deletion using a key array instead of a string.
var object = { a: [{ b: { c: 7 } }] };
_.unset(object, ["a", "0", "b", "c"]);
// → true
object;
// → { a: [{ b: {} }] }"0" selects the first array item.falseUnresolved parents return false without throwing.
var object = { a: 1 };
_.unset(object, "x.y.z");
// → false
object;
// → { a: 1 }x does not exist on the object.false — object unchanged.Works for shallow keys too — like a safe delete.
var user = { id: 1, temp: true, name: "Ada" };
_.unset(user, "temp");
// → true
user;
// → { id: 1, name: "Ada" }"temp".unset vs omitMutate nested paths vs return a new object without top-level keys.
var data = { user: { id: 1, secret: "x" }, ok: true };
_.unset(data, "user.secret");
// data is mutated → { user: { id: 1 }, ok: true }
_.omit({ a: 1, b: 2 }, ["b"]);
// → { a: 1 } (new object; source unchanged)_.cloneDeep first._.unset is a Lodash Object helper (since 4.0.0). It runs anywhere Lodash runs — modern browsers (CDN or bundle) and Node.js / Bun / Deno with npm install lodash. Closest native cousin is walking a path then using the delete operator; Lodash adds safe path parsing (dot/bracket/array) and a boolean result without throwing on missing parents.
Available in [email protected] full builds and the lodash/unset modular import. Works in evergreen browsers and current Node LTS when Lodash is installed.
Bottom line: Safe for production once Lodash is loaded. Prefer import unset from "lodash/unset" for smaller builds. Ideal for stripping nested secrets, temp flags, or draft fields.
Transform a nested value with an updater function.
10 people found this page helpful