3.1.2 • Published 5 years ago

array-includes-x v3.1.2

Weekly downloads
251
License
MIT
Repository
github
Last release
5 years ago

array-includes-x

Determines whether an array includes a certain element.

module.exportsboolean

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.
ParamTypeDescription
arrayArrayThe array to search.
searchElement*Element to locate in the array.
fromIndexnumberThe 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

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