The chainable form of _.at. Plucks values from the wrapped object or array at one or more paths. After .value() you always get an array (path order). Part of Lodash 4.x Seq / wrapper prototype.
Call it on a Lodash wrapper. Finish with .value() when you need a plain result.
Call .at(). Start with this line.
_(obj).at(paths).value()| Call | What it does |
|---|---|
_(obj).at(paths).value() | Primary signature. |
Prefer import _ from "lodash" (full build) when you need wrapper prototype helpers.
_(obj).at(paths).value()| Parameter | Description |
|---|---|
| Wrapped value | Required. Object or array to read |
| paths | Required. Dot/bracket strings or path arrays |
| Return Value | Description |
|---|---|
| * | Wrapper around values array |
Dot and bracket paths in one call.
var object = { a: [{ b: { c: 3 } }, 4] };
_(object).at(["a[0].b.c", "a[1]"]).value();
// → [3, 4]_(object) starts the sequence.a[0].b.c walks into the nested object → 3.a[1] is the number 4.[3, 4] in path order.Pass paths as separate arguments.
var user = {
name: "Alice",
email: "[email protected]",
address: { city: "Portland" }
};
_(user).at("name", "email", "address.city").value();
// → ["Alice", "[email protected]", "Portland"]address.city uses dot notation.Absent paths become undefined — no throw.
var config = { server: { host: "localhost" } };
_(config).at("server.host", "server.port", "database.name").value();
// → ["localhost", undefined, undefined]"localhost".undefined.undefined when paths may be absent._.at()Wrapper and direct forms match.
var object = { a: [{ b: { c: 3 } }, 4] };
var paths = ["a[0].b.c", "a[1]"];
var chained = _(object).at(paths).value();
var direct = _.at(object, paths);
JSON.stringify(chained) === JSON.stringify(direct);
// → true_.at call._.at._.get()One value vs many values as an array.
var user = {
name: "Bob",
profile: { age: 28, city: "Austin" }
};
_.get(user, "profile.city");
// → "Austin"
_(user).at("name", "profile.age", "profile.city").value();
// → ["Bob", 28, "Austin"]_.get.Wrapper .at() ships with Lodash 4.x Seq. It runs anywhere full Lodash runs — modern browsers (CDN or bundle) and Node.js / Bun / Deno with npm install lodash. Prefer native plucking or _.at / _.get in tree-shaken modular builds without wrappers.
Available on wrappers from _(value) / _.chain in [email protected] full builds. Works in evergreen browsers and current Node LTS when Lodash is installed.
Bottom line: Safe for production with full Lodash. Use wrapper .at inside chains; use _.at / _.get for one-shot reads.
Switch a wrapper to explicit chaining so methods like head stay wrapped.
9 people found this page helpful