https://github.com/mathiasbynens/String.prototype.includes

A robust & optimized ES3-compatible polyfill for the `String.prototype.contains` method in ECMAScript 6.
https://github.com/mathiasbynens/String.prototype.includes

Last synced: about 2 months ago
JSON representation

A robust & optimized ES3-compatible polyfill for the `String.prototype.contains` method in ECMAScript 6.

• Host: GitHub
• URL: https://github.com/mathiasbynens/String.prototype.includes
• Owner: mathiasbynens
• License: mit
• Created: 2013-12-10T15:20:51.000Z (about 11 years ago)
• Default Branch: master
• Last Pushed: 2024-10-15T07:02:08.000Z (3 months ago)
• Last Synced: 2024-11-05T05:02:57.438Z (2 months ago)
• Language: JavaScript
• Homepage: https://mths.be/includes
• Size: 25.4 KB
• Stars: 68
• Watchers: 5
• Forks: 9
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• es6-tools - `String.prototype.includes`

README

        
# ES6 `String.prototype.includes` polyfill [![Build status](https://travis-ci.org/mathiasbynens/String.prototype.includes.svg?branch=master)](https://travis-ci.org/mathiasbynens/String.prototype.includes)

A robust & optimized polyfill for [the `String.prototype.includes` method (previously known as `String.prototype.contains`) in ECMAScript 6](http://people.mozilla.org/~jorendorff/es6-draft.html#sec-string.prototype.includes).

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 [spec](https://tc39.es/ecma262/#sec-string.prototype.includes).

Other polyfills for `String.prototype.includes` are available:

*  by [Paul Miller](http://paulmillr.com/) (~~[fails some tests](https://github.com/paulmillr/es6-shim/issues/175)~~ passes all tests)

*  by Google (~~[fails a lot of tests](https://github.com/google/traceur-compiler/pull/556)~~ now uses this polyfill and passes all tests)

## Installation

Via [npm](http://npmjs.org/):

```bash

npm install string.prototype.includes

```

Then, in [Node.js](http://nodejs.org/):

```js

var includes = require('string.prototype.includes');

```

In a browser:

```html

```

> **NOTE**: It's recommended that you install this module using a package manager

> such as `npm`, because loading multiple polyfills from a CDN (such as `bundle.run`)

> will lead to duplicated code.

## Notes

Polyfills + test suites for [`String.prototype.startsWith`](https://mths.be/startswith) and [`String.prototype.endsWith`](https://mths.be/endswith) are available, too.

## Author

| [![twitter/mathias](https://gravatar.com/avatar/24e08a9ea84deb17ae121074d0f17125?s=70)](https://twitter.com/mathias "Follow @mathias on Twitter") |

|---|

| [Mathias Bynens](https://mathiasbynens.be/) |

## License

This polyfill is available under the [MIT](https://mths.be/mit) license.