Return positive value if (any of the) passed value(s) exists in array, or optionally an index

Usage no npm install needed!

<script type="module">
  import arrIncludes from '';


arr-includes npm version License Libera Manifesto

Return positive value if (any of the) passed value(s) exists in array, or optionally an index

Please consider following this project's author, Charlike Mike Reagent, and :star: the project to show your :heart: and support.

Code style CircleCI linux build CodeCov coverage status Renovate App Status Make A Pull Request Time Since Last Commit

If you have any how-to kind of questions, please read the Contributing Guide and Code of Conduct documents. For bugs reports and feature requests, please create an issue or ping @tunnckoCore at Twitter.

Conventional Commits Minimum Required Nodejs NPM Downloads Monthly NPM Downloads Total Share Love Tweet Twitter

Project is semantically versioned & automatically released from GitHub Actions with Lerna.

Become a Patron Buy me a Kofi PayPal Donation Bitcoin Coinbase Keybase PGP

Topic Contact
Any legal or licensing questions, like private or commerical use tunnckocore_legal
For any critical problems and security reports tunnckocore_security
Consulting, professional support, personal or team training tunnckocore_consulting
For any questions about Open Source, partnerships and sponsoring tunnckocore_opensource

Table of Contents

(TOC generated by verb using markdown-toc)


This project requires Node.js >=10.13 (see Support & Release Policy). Install it using yarn or npm.
We highly recommend to use Yarn when you think to contribute to this project.

$ yarn add arr-includes


Generated using jest-runner-docs.


Check if any of values exists on arr.


function(arr, values)


  • arr {Array} - array to check
  • values {Array<string>} - array or string
  • returns {boolean|number} - returns false if not found, true if index is 0 from the array, otherwise number index


import arrIncludes from 'arr-includes';

console.log(arrIncludes([1, 'bar', 55], 2)); // => false
console.log(arrIncludes([1, 'bar', 3], 3)); // => 2

console.log(arrIncludes([1, 'bar', 3, true], false)); // => false
console.log(arrIncludes([1, 'bar', 44, true], true)); // => 3

console.log(arrIncludes(['foo', 'bar'], 'baz')); // => false
console.log(arrIncludes(['foo', 'bar'], 'foo')); // => true
console.log(arrIncludes(['qux', 'foo', 'bar'], 'foo')); // => 1
console.log(arrIncludes([true, 'qqq', 'bar'], true)); // => true
console.log(arrIncludes(['true', 'qqq', 'bar'], true)); // => false
console.log(arrIncludes(['qqq', 'bar', true], true)); // => 2
console.log(arrIncludes(['qqq', 'true', 'bar'], true)); // => false
console.log(arrIncludes([false, 'foo', null, 'bar'], null)); // => 2

console.log(arrIncludes(['foo', 'bar', 'qux'], ['a', 'b', 'c'])); // => false
console.log(arrIncludes(['b', 'a', 'c'], ['a', 'b', 'c'])); // => 1
console.log(arrIncludes(['foo', 'bb', 'b'], ['a', 'b'])); // => 2
console.log(arrIncludes(['foo', 'bar', 'qux'], ['a', 'b', 'foo'])); // => true
console.log(arrIncludes(['bar', 123, 'foo', 'qux'], ['a', 'b', 'foo'])); // => 2

back to top


Guides and Community

Please read the Contributing Guide and Code of Conduct documents for advices.

For bug reports and feature requests, please join our community forum and open a thread there with prefixing the title of the thread with the name of the project if there's no separate channel for it.

Consider reading the Support and Release Policy guide if you are interested in what are the supported Node.js versions and how we proceed. In short, we support latest two even-numbered Node.js release lines.

Support the project

Become a Partner or Sponsor? :dollar: Check the OpenSource Commision (tier). :tada: You can get your company logo, link & name on this file. It's also rendered on package's page in and sites too! :rocket:

Not financial support? Okey! Pull requests, stars and all kind of contributions are always welcome. :sparkles:


This project follows the all-contributors specification. Contributions of any kind are welcome!

Thanks goes to these wonderful people (emoji key), consider showing your support to them:

Charlike Mike Reagent

🚇 💻 📖 🤔 🚧 ⚠️

back to top


Copyright (c) 2016-present, Charlike Mike Reagent <> & contributors.
Released under the MPL-2.0 License.