Like _.set, but a customizer can produce each missing path container. If it returns undefined, Lodash creates arrays for indexes and objects otherwise. Part of Lodash Object (stable — not deprecated).
Pass the object and path or keys shown below. Check whether the helper mutates or returns a new object.
Call _.setWith. Start with this line.
_.setWith(object, path, value, [customizer])| Call | What it does |
|---|---|
_.setWith(object, path, value, [customizer]) | Primary signature. |
_.setWith(object) | Work with an object’s keys, values, or paths. |
Prefer import setWith from "lodash/setWith" when you want a smaller bundle.
_.setWith(object, path, value, [customizer])| Parameter | Description |
|---|---|
| object | Required. Target object (mutated) |
| path | Required. Property path to write |
| value | Required. Leaf value at the path |
| customizer | Optional. Builds missing intermediates; undefined → default |
| Return Value | Description |
|---|---|
| * | The same mutated object |
Pass Object so numeric keys stay plain objects.
var object = {};
_.setWith(object, "[0][1]", "a", Object);
// → { "0": { "1": "a" } }[0][1] looks like nested indexes.Object builds {} instead of [].'a' is assigned normally.setWith vs setDefault _.set creates arrays for index paths.
console.log(_.setWith({}, "[0][1]", "a", Object));
// → { "0": { "1": "a" } }
console.log(_.set({}, "[0][1]", "a"));
// → [ [ undefined, "a" ] ]Object → nested plain objects.'a' at the end.undefinedFall back to Lodash’s default container rules.
var object = {};
_.setWith(object, "a.b", 1, function () {
return undefined;
});
// → { a: { b: 1 } }a.b is set to 1.ArrayPass Array when you want array containers explicitly.
var object = {};
_.setWith(object, "0.0", "x", Array);
console.log(Array.isArray(object[0])); // true
console.log(object[0][0]); // "x"Array builds [] for missing keys."x" at [0][0].Return your own container from a function customizer.
var object = {};
_.setWith(object, "meta.tag", "ok", function () {
return Object.create(null);
});
console.log(object.meta.tag); // "ok"
console.log(Object.getPrototypeOf(object.meta) === null); // trueObject.create(null).tag is still set to "ok".Object.prototype._.setWith is a Lodash Object helper available in 4.x. It runs anywhere Lodash runs — modern browsers (via CDN or bundle) and Node.js / Bun / Deno with npm install lodash. Prefer it over _.set only when you must customize intermediate creation.
Available in [email protected] full builds and the lodash/setWith modular import. Works in evergreen browsers and current Node LTS when Lodash is installed.
Bottom line: Safe for production once Lodash is on the page or in your bundle. Prefer import setWith from "lodash/setWith" for smaller builds. Use set for default rules; updateWith when the leaf needs a transform.
Turn an object into an array of [key, value] pairs.
10 people found this page helpful