This method is like _.update except that it accepts a customizer which is invoked to produce the objects of path. If customizer returns undefined, path creation is handled by the method instead. 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 _.updateWith. Start with this line.
_.updateWith(object, path, updater, [customizer])| Call | What it does |
|---|---|
_.updateWith(object, path, updater, [customizer]) | Primary signature. |
_.updateWith(object) | Work with an object’s keys, values, or paths. |
Prefer import updateWith from "lodash/updateWith" when you want a smaller bundle.
_.updateWith(object, path, updater, [customizer])| Parameter | Description |
|---|---|
| object | Required. Target object (mutated) |
| path | Required. Dot/bracket string or key array |
| updater | Required. (value) => newValue for the leaf |
| customizer | Optional. Creates missing intermediate containers |
| Return Value | Description |
|---|---|
| * | The same object reference |
Object CustomizerForce nested objects for index-looking keys.
var object = {};
_.updateWith(object, "[0][1]", _.constant("a"), Object);
// → { "0": { "1": "a" } }[0][1] looks like nested array indexes.Object builds plain objects._.constant("a") sets the leaf to "a"."0" and "1".ObjectSee how the customizer changes the shape of missing segments.
var a = {};
var b = {};
_.updateWith(a, "[0][1]", _.constant("x"));
// arrays for index-like keys
_.updateWith(b, "[0][1]", _.constant("x"), Object);
// objects for those keys
JSON.stringify(a);
// → {"0":[null,"x"]} (shape may vary by engine fill)
JSON.stringify(b);
// → {"0":{"1":"x"}}Object ContainersUpdater transforms the leaf; customizer only shapes the path.
var object = {};
_.updateWith(object, "0.1", function (n) {
return (n || 0) + 1;
}, Object);
object;
// → { "0": { "1": 1 } }undefined.(n || 0) + 1 becomes 1.Object builds { "0": { "1": … } }.undefinedReturning undefined restores Lodash’s default path creation.
var object = {};
_.updateWith(object, "a.b", _.constant(1), function () {
return undefined; // use defaults
});
object;
// → { a: { b: 1 } }a becomes {}.b to 1.updateWith vs updateReach for updateWith only when container shape matters.
var plain = {};
var forced = {};
_.update(plain, "[0][1]", _.constant("a"));
_.updateWith(forced, "[0][1]", _.constant("a"), Object);
// plain → nested arrays (default)
// forced → { "0": { "1": "a" } }set / setWith._.updateWith 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. It pairs _.update with the customizer hook from _.setWith; there is no single native equivalent.
Available in [email protected] full builds and the lodash/updateWith 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 updateWith from "lodash/updateWith" for smaller builds. Use it when missing path segments must be objects (or other custom containers).
Extract an object’s own enumerable property values.
10 people found this page helpful