lodash.omit

What is lodash.omit?

The lodash.omit package is a utility library that allows you to create a new object by omitting specified properties from an existing object. This can be particularly useful for removing sensitive information, simplifying objects, or preparing data for certain operations.

What are lodash.omit's main functionalities?

Omitting Single Property

This feature allows you to omit a single property from an object. In the example, the property 'a' is omitted from the object.

const omit = require('lodash.omit');
const object = { 'a': 1, 'b': 2, 'c': 3 };
const result = omit(object, ['a']);
console.log(result); // { 'b': 2, 'c': 3 }

Omitting Multiple Properties

This feature allows you to omit multiple properties from an object. In the example, the properties 'a' and 'c' are omitted from the object.

const omit = require('lodash.omit');
const object = { 'a': 1, 'b': 2, 'c': 3, 'd': 4 };
const result = omit(object, ['a', 'c']);
console.log(result); // { 'b': 2, 'd': 4 }

Omitting Properties Using a Function

This feature allows you to omit properties based on a function. In the example, properties where the key is 'a' or the value is 3 are omitted.

const omit = require('lodash.omit');
const object = { 'a': 1, 'b': 2, 'c': 3, 'd': 4 };
const result = omit(object, (value, key) => key === 'a' || value === 3);
console.log(result); // { 'b': 2, 'd': 4 }

Other packages similar to lodash.omit

object.omit

The object.omit package provides similar functionality to lodash.omit by allowing you to omit specified properties from an object. It is a smaller, more focused library compared to lodash.omit, which is part of the larger Lodash utility library.

omit-deep

The omit-deep package extends the functionality of lodash.omit by allowing you to omit properties from nested objects. This can be useful for more complex data structures where you need to remove properties at multiple levels.

ramda

Ramda is a functional programming library for JavaScript that includes a variety of utility functions, including R.omit, which provides similar functionality to lodash.omit. Ramda focuses on immutability and functional programming principles, making it a good choice for developers who prefer that style.

README

lodash.omit v4.5.0

The lodash method _.omit exported as a Node.js module.

Installation

Using npm:

$ {sudo -H} npm i -g npm
$ npm i --save lodash.omit

In Node.js:

var omit = require('lodash.omit');

See the documentation or package source for more details.