# string.prototype.includes

> A robust & optimized `String.prototype.includes` polyfill, based on the ECMAScript 6 specification.

Latest version **2.0.1** (published 2024-10-15) · MIT license · 0 weekly downloads

## Install

```sh
npm install string.prototype.includes
pnpm add string.prototype.includes
yarn add string.prototype.includes
bun add string.prototype.includes
```

## Health

**Score 30/100 (F)** — status: maintenance-mode.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: stale; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.1 |
| Published | 2024-10-15 |
| First published | 2014-11-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Node | >= 0.4 |
| Dependencies | 3 |
| Unpacked size | 15.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 70 |
| Author | Mathias Bynens |
| Maintainers | mathias, nicolo-ribaudo |
| Keywords | string, includes, es6, ecmascript, polyfill |

## Links

- npm: https://www.npmjs.com/package/string.prototype.includes
- Repository: https://github.com/mathiasbynens/String.prototype.includes
- Homepage: https://mths.be/includes
- Issues: https://github.com/mathiasbynens/String.prototype.includes/issues
- npm.io page: https://npm.io/package/string.prototype.includes

## Dependencies (3)

- [call-bind](https://npm.io/package/call-bind.md) ^1.0.7
- [es-abstract](https://npm.io/package/es-abstract.md) ^1.23.3
- [define-properties](https://npm.io/package/define-properties.md) ^1.2.1

## Alternatives

- [@mce/gif](https://npm.io/package/@mce/gif.md) — 2.6K weekly downloads
- [cleanse](https://npm.io/package/cleanse.md) — 173 weekly downloads
- [str](https://npm.io/package/str.md) — 127 weekly downloads
- [naming](https://npm.io/package/naming.md) — 95 weekly downloads
- [tap-telco-api](https://npm.io/package/tap-telco-api.md) — 19 weekly downloads

## Recent versions

- 2.0.1 (latest) — 2024-10-15
- 2.0.0 — 2020-05-21
- 1.0.0 — 2014-11-20

## 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:

* <https://github.com/paulmillr/es6-shim/blob/d8c4ec246a15e7df55da60b7f9b745af84ca9021/es6-shim.js#L186-L190> by [Paul Miller](http://paulmillr.com/) (~~[fails some tests](https://github.com/paulmillr/es6-shim/issues/175)~~ passes all tests)
* <https://github.com/google/traceur-compiler/blob/315bdad05d41de46d25337422d66686d63100d7a/src/runtime/polyfills/String.js#L68-L86> 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
<script src="https://bundle.run/string.prototype.includes"></script>
```

> **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.

---
_Source: https://npm.io/package/string.prototype.includes · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._