Creates a function that invokes the given functions from left to right, passing each return value to the next. Part of Lodash Util since 3.0.0 (stable — not deprecated).
Note: Only the first function receives all outer arguments. Later steps get one value. See also _.flowRight for right-to-left order.
Call _.flow. Start with this line.
_.flow([funcs]) or _.flow(f, g, …)| Call | What it does |
|---|---|
_.flow([funcs]) or _.flow(f, g, …) | Primary signature. |
_.flow(...) | Call the util helper. |
Prefer import flow from "lodash/flow" when you want a smaller bundle.
_.flow([funcs]) or _.flow(f, g, …)| Parameter | Description |
|---|---|
| funcs | Optional. Functions to invoke (array and/or rest args) |
| Return Value | Description |
|---|---|
| * | New composite function |
Compose _.add and a square helper left to right.
function square(n) {
return n * n;
}
var addSquare = _.flow([_.add, square]);
addSquare(1, 2);
// → 9_.add(1, 2) → 3.square(3) → 9.addSquare is one named pipeline.Same pipeline without wrapping functions in an array.
function square(n) {
return n * n;
}
var addSquare = _.flow(_.add, square);
addSquare(1, 2);
// → 9_.add and square are listed directly._.flow([_.add, square]).9 for (1, 2).Trim, then uppercase — a common left-to-right cleanup chain.
var clean = _.flow(_.trim, _.toUpper);
clean(" hello ");
// → "HELLO"_.trim(" hello ") → "hello"._.toUpper("hello") → "HELLO".clean on any padded string.flow vs flowRightSame unary steps, opposite invoke order.
function addOne(n) {
return n + 1;
}
function double(n) {
return n * 2;
}
_.flow(addOne, double)(3);
// → 8 // (3 + 1) * 2
_.flowRight(addOne, double)(3);
// → 7 // (3 * 2) + 18.7.flow when you want pipeline reading order.Extra arguments reach only the first function in the chain.
function joinPair(a, b) {
return a + "-" + b;
}
var shout = _.flow(joinPair, _.toUpper);
shout("hi", "there");
// → "HI-THERE"joinPair("hi", "there") gets both args → "hi-there"._.toUpper receives that one string._.partial._.flow is a Lodash Util helper since 3.0.0. It runs anywhere Lodash runs — modern browsers (CDN or bundle) and Node.js / Bun / Deno with npm install lodash.
Available in [email protected] full builds and the lodash/flow 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 flow from "lodash/flow" for smaller bundles. Use it for fixed left-to-right transform pipelines.
Compose the same way, but invoke functions from right to left.
10 people found this page helpful