array-includes
Advanced tools
Package description
The array-includes npm package provides a simple utility function for checking if an array includes a certain element, with optional support for the fromIndex parameter. It is a polyfill for the Array.prototype.includes method, which is part of the ECMAScript 2016 (ES7) standard but may not be available in all environments.
Check if an array includes a specific element
This feature allows you to check if an array contains a specific element. It returns true if the element is found, otherwise false.
var arrayIncludes = require('array-includes');
var myArray = [1, 2, 3];
var includesTwo = arrayIncludes(myArray, 2); // trueCheck if an array includes a specific element starting from a given index
This feature allows you to check if an array contains a specific element, starting the search from a given index. It is useful when you want to ignore certain elements at the beginning of the array.
var arrayIncludes = require('array-includes');
var myArray = [1, 2, 3, 2];
var includesTwoFromIndex2 = arrayIncludes(myArray, 2, 2); // trueLodash is a popular utility library that includes a method called _.includes. This method is similar to array-includes but offers additional features such as deep path string checks for objects and is part of a larger utility library.
Underscore is another utility library that provides a method called _.contains (also aliased as _.includes). It is similar to array-includes but is part of a larger set of utility functions for working with arrays, objects, and functions.
Changelog
v3.1.6 - 2022-11-07
auto-changelog c5fbe72npmignore to autogenerate an npmignore file dbd6dc8es-abstract, get-intrinsic b819e3b6e241d5aud, tape 9b2a9310a0c758define-properties, es-abstracteslint, @ljharb/eslint-config, @es-shims/api, aud, functions-have-names, safe-publish-latest, tapeMath.max calles-abstract, is-stringprepublishOnly script for npm 7+node/install instead of node/run; use codecov actioneslint, @ljharb/eslint-config, @es-shims/api, aud, tapecall-bind, es-abstract, get-intrinsiceslint, @ljharb/eslint-config, aud, functions-have-names, has-strict-mode, tape.applyes-abstract; use call-bind and get-intrinsic where applicableeslint, @ljharb/eslint-config, functions-have-names, tape; add aud, safe-publish-latestpull_request_target eventnyc on all testsimplementation test; run es-shim-api in postlint; use tape runneres-abstracteslint, @ljharb/eslint-config, tapeauto entry pointes-abstract (68% bundle size decrease)es-abstract, define-propertieseslint, @ljharb/eslint-config, evalmd, covert, functions-have-names, replace, semver, tape, @es-shims/api, function-bindfunding field, FUNDING.ymlfromIndex testsnpx aud instead of nsp or npm audit with hoopsjscsfunctions-have-namesnpm audit instead of nspjscsshim.js actually shims when the polyfill differs from nativenode v7.9, v6.10, v4.8; comment out OS X builds; improve test matrixnsp, eslint, @ljharb/eslint-config, tape, jscs, semver, function-bind, @es-shims/apies-abstractes-abstractjscs, nsp, eslint, @ljharb/eslint-config, semvernode v5.5node v0.8evalmd as part of the full test suite, since it's more like a linterdefine-properties, es-abstracteslint, semver, nsp, semver, jscseslint configio.js v3.0io.js v2.0es-abstract, tape, eslint, semver, jscs, semveres-abstract, editorconfig-tools, nsp, eslint, semvernode/iojs versions now ship with an npm that understands ^.travis-ci tests on iojs and node v0.12; allow 0.8 failures.tape, jscs, es-abstract, remove is.tape, jscs, nsp, eslint, es-abstractes-abstract for ECMAScript spec internal abstract operationsnpmReadme
An ES7/ES2016 spec-compliant Array.prototype.includes shim/polyfill/replacement that works as far down as ES3.
This package implements the es-shim API interface. It works in an ES3-supported environment and complies with the proposed spec.
Because Array.prototype.includes depends on a receiver (the this value), the main export takes the array to operate on as the first argument.
Engines that need this package include:
npm install --save array-includes
Basic usage: includes(array, value[, fromIndex=0])
var includes = require('array-includes');
var assert = require('assert');
var arr = [ 'one', 'two' ];
includes(arr, 'one'); // true
includes(arr, 'three'); // false
includes(arr, 'one', 1); // false
var arr = [
1,
'foo',
NaN,
-0
];
assert.equal(arr.indexOf(0) > -1, true);
assert.equal(arr.indexOf(-0) > -1, true);
assert.equal(includes(arr, 0), true);
assert.equal(includes(arr, -0), true);
assert.equal(arr.indexOf(NaN) > -1, false);
assert.equal(includes(arr, NaN), true);
assert.equal(includes(arr, 'foo', 0), true);
assert.equal(includes(arr, 'foo', 1), true);
assert.equal(includes(arr, 'foo', 2), false);
/* when Array#includes is not present */
delete Array.prototype.includes;
var shimmedIncludes = includes.shim();
assert.equal(shimmedIncludes, includes.getPolyfill());
assert.equal(arr.includes('foo', 1), includes(arr, 'foo', 1));
/* when Array#includes is present */
var shimmedIncludes = includes.shim();
assert.equal(shimmedIncludes, Array.prototype.includes);
assert.equal(arr.includes(1, 'foo'), includes(arr, 1, 'foo'));
Simply clone the repo, npm install, and run npm test
FAQs
An ES7/ES2016 spec-compliant `Array.prototype.includes` shim/polyfill/replacement that works as far down as ES3.
The npm package array-includes receives a total of 20,938,943 weekly downloads. As such, array-includes popularity was classified as popular.
We found that array-includes demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.
Security News
GitHub is susceptible to a CDN flaw that allows attackers to host malware on any public repository.
Security News
At Node Congress, Socket CEO Feross Aboukhadijeh uncovers the darker aspects of open source, where applications that rely heavily on third-party dependencies can be exploited in supply chain attacks.