This method is like _.set except that it accepts an updater to produce the value to set. Mutates object and returns it. Part of Lodash 4.x Object (since 4.6.0).
Pass the object and path or keys shown below. Check whether the helper mutates or returns a new object.
Call _.update. Start with this line.
_.update(object, path, updater)| Call | What it does |
|---|---|
_.update(object, path, updater) | Primary signature. |
_.update(object) | Work with an object’s keys, values, or paths. |
Prefer import update from "lodash/update" when you want a smaller bundle.
_.update(object, path, updater)| Parameter | Description |
|---|---|
| object | Required. Target object (mutated) |
| path | Required. Dot/bracket string or key array |
| updater | Required. (value) => newValue |
| Return Value | Description |
|---|---|
| * | The same object reference |
Read c, square it, write it back.
var object = { a: [{ b: { c: 3 } }] };
_.update(object, "a[0].b.c", function (n) {
return n * n;
});
object.a[0].b.c;
// → 93.9.9 back at the path.undefinedUpdater must handle a missing value; intermediates are created.
var object = { a: [{ b: { c: 3 } }] };
_.update(object, "x[0].y.z", function (n) {
return n ? n + 1 : 0;
});
object.x[0].y.z;
// → 0n is undefined.0.x[0].y containers.z to 0.Classic updater: flip true/false.
var settings = { ui: { dark: false } };
_.update(settings, "ui.dark", function (on) {
return !on;
});
settings.ui.dark;
// → truefalse.!on → true.Add one to a nested score using an array path.
var game = { players: [{ score: 10 }] };
_.update(game, ["players", "0", "score"], function (n) {
return n + 1;
});
game.players[0].score;
// → 11players[0].score.10.11.update vs setUse set when you already know the value; update when you derive it.
var a = { n: 2 };
var b = { n: 2 };
_.set(a, "n", 5);
// a.n → 5 (you supplied 5)
_.update(b, "n", function (n) {
return n * 2;
});
// b.n → 4 (derived from 2)_.update is a Lodash Object helper (since 4.6.0). It runs anywhere Lodash runs — modern browsers (CDN or bundle) and Node.js / Bun / Deno with npm install lodash. Closest pattern is _.set(obj, path, updater(_.get(obj, path))); Lodash packages that into one call with shared path parsing.
Available in [email protected] full builds and the lodash/update 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 update from "lodash/update" for smaller builds. Ideal for toggles, counters, and derived nested writes.
Transform a nested value and customize intermediate containers.
10 people found this page helpful