@ndhoule/includes

Determine whether or not a value is contained by a given collection.


Keywords
component, functional, includes
License
MIT
Install
npm install @ndhoule/includes@2.0.1

Documentation

includes CI

Determine whether or not a value is contained by a given collection.

Uses SameValueZero (the algorithm used by Object.is) for equality comparisons.

Installation

$ component install ndhoule/includes
$ npm install @ndhoule/includes

API

includes(searchElement : *, collection : Object|Array|string) => boolean

includes(2, [1, 2, 3]);
//=> true

includes(4, [1, 2, 3]);
//=> false

includes(2, { a: 1, b: 2, c: 3 });
//=> true

includes('a', { a: 1, b: 2, c: 3 });
//=> false

includes('abc', 'xyzabc opq');
//=> true

includes('nope', 'xyzabc opq');
//=> false

License

Released under the MIT license.