Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/es-shims/array-includes

Array.prototype.includes spec-compliant polyfill
https://github.com/es-shims/array-includes

array contains ecmascript includes javascript polyfill shim

Last synced: about 1 month ago
JSON representation

Array.prototype.includes spec-compliant polyfill

Host: GitHub
URL: https://github.com/es-shims/array-includes
Owner: es-shims
License: mit
Created: 2015-01-03T19:50:23.000Z (over 9 years ago)
Default Branch: main
Last Pushed: 2024-03-20T20:47:27.000Z (3 months ago)
Last Synced: 2024-05-09T11:22:55.732Z (about 2 months ago)
Topics: array, contains, ecmascript, includes, javascript, polyfill, shim
Language: JavaScript
Homepage: https://tc39.github.io/ecma262/#sec-array.prototype.includes
Size: 196 KB
Stars: 43
Watchers: 4
Forks: 12
Open Issues: 1
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Lists

awesome-ponyfills - array-includes - [`Array.prototype.includes`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/includes) (Arrays)
awesome-stars - array-includes - compliant polyfill | es-shims | 36 | (JavaScript)

README

        # array-includes ^{[![Version Badge][npm-version-svg]][package-url]}

[![github actions][actions-image]][actions-url]

[![coverage][codecov-image]][codecov-url]

[![dependency status][deps-svg]][deps-url]

[![dev dependency status][dev-deps-svg]][dev-deps-url]

[![License][license-image]][license-url]

[![Downloads][downloads-image]][downloads-url]

[![npm badge][npm-badge-png]][package-url]

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](https://github.com/es-shims/api) interface. It works in an ES3-supported environment and complies with the proposed [spec](https://262.ecma-international.org/6.0/).

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-101

 - Chrome < 47

 - Edge < 14

 - node < 6

## Getting started

```sh

npm install --save array-includes

```

## Usage

Basic usage: **includes(array, value[, fromIndex=0])**

```js

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

```js

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

```

```js

/* 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));

```

```js

/* 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`

[package-url]: https://npmjs.org/package/array-includes

[npm-version-svg]: https://versionbadg.es/es-shims/array-includes.svg

[deps-svg]: https://david-dm.org/es-shims/array-includes.svg

[deps-url]: https://david-dm.org/es-shims/array-includes

[dev-deps-svg]: https://david-dm.org/es-shims/array-includes/dev-status.svg

[dev-deps-url]: https://david-dm.org/es-shims/array-includes#info=devDependencies

[npm-badge-png]: https://nodei.co/npm/array-includes.png?downloads=true&stars=true

[license-image]: https://img.shields.io/npm/l/array-includes.svg

[license-url]: LICENSE

[downloads-image]: https://img.shields.io/npm/dm/array-includes.svg

[downloads-url]: https://npm-stat.com/charts.html?package=array-includes

[codecov-image]: https://codecov.io/gh/es-shims/array-includes/branch/main/graphs/badge.svg

[codecov-url]: https://app.codecov.io/gh/es-shims/array-includes/

[actions-image]: https://img.shields.io/endpoint?url=https://github-actions-badge-u3jn4tfpocch.runkit.sh/es-shims/array-includes

[actions-url]: https://github.com/es-shims/array-includes/actions