Build a new object by dropping properties where a predicate returns truthy. Part of Lodash Object (stable — not deprecated). The predicate is invoked as (value, key). Opposite of _.pickBy.
Pass the object and path or keys shown below. Check whether the helper mutates or returns a new object.
Call _.omitBy. Start with this line.
_.omitBy(object, [predicate=_.identity])| Call | What it does |
|---|---|
_.omitBy(object, [predicate=_.identity]) | Primary signature. |
_.omitBy(object) | Work with an object’s keys, values, or paths. |
Prefer import omitBy from "lodash/omitBy" when you want a smaller bundle.
_.omitBy(object, [predicate=_.identity])| Parameter | Description |
|---|---|
| object | Required. Source object to filter |
| predicate | Optional. Invoked as (value, key); default _.identity |
| Return Value | Description |
|---|---|
| * | New object without matching properties |
Drop every property whose value is a number.
var object = { a: 1, b: "2", c: 3 };
_.omitBy(object, _.isNumber);
// → { b: "2" }_.isNumber checks each value.1 and 3 are numbers → dropped."2" is a string → kept.null / undefinedKeep 0 and false; drop only nil values.
var data = {
name: "Ada",
score: 0,
active: false,
note: null,
meta: undefined
};
_.omitBy(data, _.isNil);
// → { name: "Ada", score: 0, active: false }null and undefined.0 and false stay — they are not nil.0 / false.Use the second predicate argument to filter keys.
var user = {
id: 1,
name: "Sam",
_token: "secret",
_cache: true
};
_.omitBy(user, function (value, key) {
return key.charAt(0) === "_";
});
// → { id: 1, name: "Sam" }key as the second arg._ return truthy → omitted.id and name remain._.omit is simpler.omitBy vs pickBySame predicate, opposite results.
var object = { a: 1, b: "2", c: 3 };
console.log(_.omitBy(object, _.isNumber));
// → { b: "2" }
console.log(_.pickBy(object, _.isNumber));
// → { a: 1, c: 3 }_.isNumber on the same object.omitBy vs omitPredicate rules vs a fixed key list.
var user = { id: 1, name: "Sam", password: "x" };
_.omit(user, "password");
// → { id: 1, name: "Sam" }
_.omitBy(user, function (value, key) {
return key === "password";
});
// → { id: 1, name: "Sam" }password here._.omitBy 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 loop Object.keys and copy keys the predicate rejects.
Available in [email protected] full builds and the lodash/omitBy 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 omitBy from "lodash/omitBy" for smaller builds. Use omit for fixed key lists; pickBy when you want to keep matches.
Keep a fixed list of object paths or keys.
10 people found this page helpful