Invokes the method at path of object and returns the result. Part of Lodash Object (stable — not deprecated). Extra arguments after path are forwarded to the method. For the same call across a collection, use _.invokeMap.
Pass the object and path or keys shown below. Check whether the helper mutates or returns a new object.
Call _.invoke. Start with this line.
_.invoke(object, path, ...args)| Call | What it does |
|---|---|
_.invoke(object, path, ...args) | Primary signature. |
_.invoke(object) | Work with an object’s keys, values, or paths. |
Prefer import invoke from "lodash/invoke" when you want a smaller bundle.
_.invoke(object, path, ...args)| Parameter | Description |
|---|---|
| object | Required. Object to query |
| path | Required. String or array path to the method |
| ...args | Optional. Arguments forwarded to the method |
| Return Value | Description |
|---|---|
| * | Result of the invoked method |
sliceResolve a deep array and call a method on it.
var object = { a: [{ b: { c: [1, 2, 3, 4] } }] };
console.log(_.invoke(object, "a[0].b.c.slice", 1, 3));
// [2, 3][1, 2, 3, 4].slice on that array.1, 3 → slice(1, 3).Array paths avoid ambiguous dotted keys.
var object = { a: [{ b: { c: [1, 2, 3, 4] } }] };
console.log(_.invoke(object, ["a", 0, "b", "c", "slice"], 1, 3));
// [2, 3]['a', 0, 'b', 'c', 'slice'] mirrors the string path.slice(1, 3) result.Any values after path are method arguments.
var data = { tags: ["js", "lodash", "node"] };
console.log(_.invoke(data, "tags.join", " | "));
// 'js | lodash | node'
console.log(_.invoke(data, "tags.includes", "lodash"));
// true" | " is the first method arg."lodash" is forwarded.data.tags for both calls.undefinedSafe when the method may not exist.
var object = { a: [{ b: { c: [1, 2, 3, 4] } }] };
console.log(_.invoke(object, "a[0].b.c.missing", 1));
// undefined
console.log(_.invoke(object, "nope.slice", 0, 1));
// undefinedmissing is not a function → undefined.typeof when unsure._.invoke vs _.invokeMapOne object vs every item in a collection.
var one = { nums: [1, 2, 3, 4] };
var many = [[1, 2, 3, 4], [5, 6, 7, 8]];
console.log(_.invoke(one, "nums.slice", 1, 3));
// [2, 3]
console.log(_.invokeMap(many, "slice", 1, 3));
// [[2, 3], [6, 7]]invoke.invokeMap._.invoke 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. Native equivalents resolve a path then call the function with the correct parent as this.
Available in [email protected] full builds and the lodash/invoke 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 invoke from "lodash/invoke" for smaller builds. Use invokeMap for collection-wide calls.
List an object’s own enumerable property names.
10 people found this page helpful