UNPKG

630 BTypeScriptView Raw
1/**
2 * Determines whether an itreable includes a certain value among its entries, returning true or false as appropriate.
3 *
4 * @export
5 * @template T The type of elements in the source sequence.
6 * @param {Iterable<T>} source The source sequence to search for the item.
7 * @param {T} valueToFind The value to search for.
8 * @param {number} [fromIndex=0] The position in this iterable at which to begin searching for valueToFind.
9 * @returns {boolean} Returns true if the value valueToFind is found within the iterable.
10 */
11export declare function includes<T>(source: Iterable<T>, searchElement: T, fromIndex?: number): boolean;