This method returns false. Part of Lodash Util since 4.13.0 (stable — not deprecated).
Note: Arguments are ignored. Equivalent idea to _.constant(false), with a clearer name for boolean stubs.
Call _.stubFalse. Start with this line.
_.stubFalse()| Call | What it does |
|---|---|
_.stubFalse() | Primary signature. |
_.stubFalse(...) | Call the util helper. |
Prefer import stubFalse from "lodash/stubFalse" when you want a smaller bundle.
_.stubFalse()This method has no parameters beyond those shown in the signature.
| Return Value | Description |
|---|---|
| * | Always false |
_.times + stubFalseBuild an array of false values.
_.times(2, _.stubFalse);
// → [false, false]_.stubFalse — no trailing ()._.times calls it for indexes 0 and 1.false.[false, false].Invoke the stub yourself when you need a boolean now.
_.stubFalse();
// → false
_.stubFalse();
// → falsefalse.Host APIs may pass indexes or values — the stub still returns false.
_.stubFalse(true);
// → false
_.stubFalse(1, 2, 3);
// → falsetrue does not change the result.false._.identity, input never passes through.As a predicate, every item fails — useful as a reject-all mock.
_.filter([1, 2, 3], _.stubFalse);
// → []stubFalse vs stubTrueOpposite boolean stubs side by side.
_.stubFalse();
// → false
_.stubTrue();
// → true
_.times(2, _.stubTrue);
// → [true, true]false.true.true._.stubFalse is a Lodash Util helper since 4.13.0. It runs anywhere Lodash 4.13+ runs — modern browsers (CDN or bundle) and Node.js / Bun / Deno with npm install lodash.
Available in [email protected] full builds and the lodash/stubFalse modular import. Works in evergreen browsers and current Node LTS when Lodash ≥ 4.13 is installed.
Bottom line: Safe for production once Lodash 4.13+ is loaded. Prefer import stubFalse from "lodash/stubFalse" for smaller bundles. Use it as a named always-false callback.
Return a new empty object on every call.
10 people found this page helpful