An open API service indexing awesome lists of open source software.

https://github.com/xotic750/array-includes-x

Determines whether an array includes a certain element.
https://github.com/xotic750/array-includes-x

array browser includes javascript nodejs

Last synced: 6 months ago
JSON representation

Determines whether an array includes a certain element.

Awesome Lists containing this project

README

          


Travis status


Dependency status


devDependency status


npm version


jsDelivr hits


bettercodehub score


Coverage Status

## array-includes-x

Determines whether an array includes a certain element.

### `module.exports` ⇒ boolean

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

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

- TypeError If `array` is `null` or `undefined`.

| Param | Type | Description |
| ------------- | ------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| array | Array | The array to search. |
| searchElement | \* | Element to locate in the `array`. |
| [fromIndex] | number | 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
```