lodash.includes

What is lodash.includes?

The lodash.includes package is a utility library that provides a method to check if a value is present in a collection (array, string, or object). It is a part of the larger Lodash library, which is known for its utility functions for common programming tasks.

What are lodash.includes's main functionalities?

Check if a value is in an array

This feature allows you to check if a specific value is present in an array. In the example, it checks if the number 3 is in the array [1, 2, 3, 4].

const includes = require('lodash.includes');
const array = [1, 2, 3, 4];
const result = includes(array, 3);
console.log(result); // true

Check if a value is in a string

This feature allows you to check if a substring is present in a string. In the example, it checks if the substring 'world' is in the string 'hello world'.

const includes = require('lodash.includes');
const string = 'hello world';
const result = includes(string, 'world');
console.log(result); // true

Check if a value is in an object

This feature allows you to check if a value is present in an object. In the example, it checks if the value 2 is in the object { 'a': 1, 'b': 2, 'c': 3 }.

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

Other packages similar to lodash.includes

underscore

Underscore is a JavaScript library that provides utility functions for common programming tasks. It includes a method called 'contains' which is similar to lodash.includes. However, Lodash is generally considered to be faster and more feature-rich compared to Underscore.

ramda

Ramda is a functional programming library for JavaScript. It provides a method called 'includes' which is similar to lodash.includes. Ramda focuses more on functional programming paradigms and immutability, whereas Lodash provides a broader range of utility functions.

array-includes

array-includes is a small, focused package that provides a method to check if a value is present in an array. It is similar to lodash.includes but is limited to arrays only. It is a lightweight alternative if you only need to work with arrays.

README

lodash.includes v4.3.0

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

Installation

Using npm:

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

In Node.js:

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

See the documentation or package source for more details.