_.includes(collection, value, [fromIndex=0])

sourcenpm package

Checks if value is in collection. If collection is a string, it's checked for a substring of value, otherwise SameValueZero is used for equality comparisons. If fromIndex is negative, it's used as the offset from the end of collection.

Since

0.1.0

Arguments

  • collection (Array|Object|string): The collection to inspect.
  • value (*): The value to search for.
  • [fromIndex=0] (number): The index to search from.

Returns

(boolean): Returns true if value is found, else false.

Example

  1. _.includes([1, 2, 3], 1);
    // => true
    _.includes([1, 2, 3], 1, 2);
    // => false
    _.includes({ 'a': 1, 'b': 2 }, 1);
    // => true
    _.includes('abcd', 'bc');
    // => true