array-includes-x/README.md

Determines whether an array includes a certain element.

<a
  href="https://travis-ci.org/Xotic750/array-includes-x"
  title="Travis status">
<img
  src="https://travis-ci.org/Xotic750/array-includes-x.svg?branch=master"
  alt="Travis status" height="18">
</a>
<a
  href="https://david-dm.org/Xotic750/array-includes-x"
  title="Dependency status">
<img src="https://david-dm.org/Xotic750/array-includes-x/status.svg"
  alt="Dependency status" height="18"/>
</a>
<a
  href="https://david-dm.org/Xotic750/array-includes-x?type=dev"
  title="devDependency status">
<img src="https://david-dm.org/Xotic750/array-includes-x/dev-status.svg"
  alt="devDependency status" height="18"/>
</a>
<a
  href="https://badge.fury.io/js/array-includes-x"
  title="npm version">
<img src="https://badge.fury.io/js/array-includes-x.svg"
  alt="npm version" height="18">
</a>
<a
  href="https://www.jsdelivr.com/package/npm/array-includes-x"
  title="jsDelivr hits">
<img src="https://data.jsdelivr.com/v1/package/npm/array-includes-x/badge?style=rounded"
  alt="jsDelivr hits" height="18">
</a>
<a
  href="https://bettercodehub.com/results/Xotic750/array-includes-x"
  title="bettercodehub score">
<img src="https://bettercodehub.com/edge/badge/Xotic750/array-includes-x?branch=master"
  alt="bettercodehub score" height="18">
</a>
<a
  href="https://coveralls.io/github/Xotic750/array-includes-x?branch=master"
  title="Coverage Status">
<img src="https://coveralls.io/repos/github/Xotic750/array-includes-x/badge.svg?branch=master"
  alt="Coverage Status" height="18">
</a>

<a name="module_array-includes-x"></a>

## array-includes-x

Determines whether an array includes a certain element.

<a name="exp_module_array-includes-x--module.exports"></a>

### `module.exports` ⇒ <code>boolean</code> ⏏

This method determines whether an array includes a certain element,
returning true or false as appropriate.

**Kind**: Exported member  
**Returns**: <code>boolean</code> - `true` if searched element is included; otherwise `false`.  
**Throws**:

- <code>TypeError</code> If `array` is `null` or `undefined`.

| Param         | Type                | Description                                                                                                                                                           |
| ------------- | ------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| array         | <code>Array</code>  | The array to search.                                                                                                                                                  |
| searchElement | <code>\*</code>     | Element to locate in the `array`.                                                                                                                                     |
| [fromIndex]   | <code>number</code> | The position in this array at which to begin searching for searchElement. A negative value searches from the index of array.length + fromIndex by asc. Defaults to 0. |

**Example**

```js
import includes from 'array-includes-x';

const subject = [2, 3, undefined, true, 'hej', null, 2, false, 0, -0, NaN];
console.log(includes(subject, undefined)); // true
console.log(includes(subject, undefined, 3)); // false
console.log(includes(subject, NaN)); // true
console.log(includes(subject, 10)); // false
```