# string-includes

> ES6 String.includes() ponyfill

Latest version **2.0.0** (published 2016-10-31) · MIT license · 0 weekly downloads

## Install

```sh
npm install string-includes
pnpm add string-includes
yarn add string-includes
bun add string-includes
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.0 |
| Published | 2016-10-31 |
| First published | 2015-05-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=4 |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 6 |
| Author | Kevin Martensson |
| Maintainers | kevva |
| Keywords | es6, includes, polyfill, ponyfill, string |

## Links

- npm: https://www.npmjs.com/package/string-includes
- Repository: https://github.com/kevva/string-includes
- Homepage: https://github.com/kevva/string-includes#readme
- Issues: https://github.com/kevva/string-includes/issues
- npm.io page: https://npm.io/package/string-includes

## 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.0 (latest) — 2016-10-31
- 1.0.1 — 2016-09-30
- 1.0.0 — 2015-05-26

## README

# string-includes [![Build Status](https://travis-ci.org/kevva/string-includes.svg?branch=master)](https://travis-ci.org/kevva/string-includes)

> ES6 [`String.includes()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/includes) [ponyfill](https://ponyfill.com)

> Ponyfill: A polyfill that doesn't overwrite the native method


## Install

```
$ npm install --save string-includes
```


## Usage

```js
const stringIncludes = require('string-includes');

stringIncludes('unicorns and rainbows', 'unicorns');
//=> true

stringIncludes('unicorns and rainbows', 'rainbows');
//=> true

stringIncludes('unicorns and rainbows', 'unicorns', 1);
//=> false
```


## API

### stringIncludes(string, searchString, [position])

#### string

Type: `string`

The string to search in.

#### searchString

Type: `string`

A string to be searched for.

#### position

Type: `Number`<br>
Default: `0`

The position in this string at which to begin searching for `searchString`.


## License

MIT © [Kevin Martensson](https://github.com/kevva)

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