Executes the chain sequence and returns the wrapped result. Call it on a Lodash wrapper from _(value) or _.chain(value). Part of Lodash Seq (since 3.2.0).
Call it on a Lodash wrapper. Finish with .value() when you need a plain result.
Call _.prototype.commit(). Start with this line.
wrapper.commit()| Call | What it does |
|---|---|
wrapper.commit() | Primary signature. |
Prefer import _ from "lodash" (full build) when you need wrapper prototype helpers.
wrapper.commit()| Parameter | Description |
|---|---|
| Receiver | Required. A Lodash wrapper instance |
| Return Value | Description |
|---|---|
| * | New wrapper around the flushed value |
pushMutations wait until commit (or unwrap).
var array = [1, 2];
var wrapped = _(array).push(3);
JSON.stringify(array);
// → "[1,2]"
wrapped = wrapped.commit();
JSON.stringify(array);
// → "[1,2,3]".push(3) is pending on the wrapper.array is still [1, 2]..commit() runs the queue (via .value() under the hood).array is [1, 2, 3] and you still have a wrapper.Flush, then call more wrapper methods.
var array = [1, 2];
var wrapped = _(array).push(3).commit();
wrapped.last();
// → 3
JSON.stringify(array);
// → "[1,2,3]"push(3) and returns a wrapper..last() reads from the updated array.3.commit vs valueSame flush; different return type.
var a = [1, 2];
var b = [1, 2];
var afterCommit = _(a).push(3).commit();
var afterValue = _(b).push(4).value();
typeof afterCommit.value === "function";
// → true (still a wrapper)
Array.isArray(afterValue);
// → true (plain array [1, 2, 4])push..value is still a method.commit; done → value.reverseAnother mutating method that waits for a flush.
var array = [1, 2, 3];
var wrapped = _(array).reverse();
JSON.stringify(array);
// → "[1,2,3]"
wrapped.commit();
JSON.stringify(array);
// → "[3,2,1]".reverse() is deferred on the wrapper.array in place.[3, 2, 1].Flush once, then queue another mutation.
var array = [1, 2];
_(array)
.push(3)
.commit()
.push(4)
.commit();
JSON.stringify(array);
// → "[1,2,3,4]"push(3) → [1, 2, 3].push(4) waits again.[1, 2, 3, 4].Wrapper .commit() is a Lodash Seq prototype method (since 3.2.0). It needs no special browser APIs beyond loading Lodash.
Available in [email protected] full builds when using _(value) / _.chain(value). Works in evergreen browsers and Node / Bun / Deno when Lodash is installed.
Bottom line: Safe for production once Lodash is on the page or in your bundle. Prefer the full lodash build for Seq / wrapper APIs.
Step through a lazy Lodash sequence with the iterator protocol.
8 people found this page helpful