Big update!Announcing Socket for GitHub 1.0. Learn more
Socket
BlogLoveFAQ
Install
Log in

array-includes

Package Overview
Dependencies
5
Maintainers
1
Versions
20
Issues
File Explorer

Advanced tools

array-includes

An ES7/ES2016 spec-compliant `Array.prototype.includes` shim/polyfill/replacement that works as far down as ES3.

    3.1.5latest

Version published
Maintainers
1
Weekly downloads
17,742,733
decreased by-3.92%

Weekly downloads

Readme

Source

array-includes Version Badge

github actions coverage dependency status dev dependency status License Downloads

npm badge

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:

  • IE (all versions)
  • Safari < 9
  • Firefox < 43, and 99+
  • Chrome < 47
  • Edge < 14
  • node < 6

Getting started

npm install --save array-includes

Usage

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

Example

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'));

Tests

Simply clone the repo, npm install, and run npm test

Keywords

FAQs

What is array-includes?

An ES7/ES2016 spec-compliant `Array.prototype.includes` shim/polyfill/replacement that works as far down as ES3.

Is array-includes popular?

The npm package array-includes receives a total of 14,176,649 weekly downloads. As such, array-includes popularity was classified as popular.

Is array-includes well maintained?

We found that array-includes demonstrated a healthy version release cadence and project activity. It has 1 open source maintainer collaborating on the project.

Last updated on 03 May 2022
Socket

Product

Subscribe to our newsletter

Get open source security insights delivered straight into your inbox. Be the first to learn about new features and product updates.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc