UNPKG

812 BTypeScriptView Raw
1/**
2 * Determines whether an async-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 {AsyncIterable<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 async-iterable at which to begin searching for valueToFind.
9 * @param {AbortSignal} [signal] An optional abort signal to cancel the operation at any time.
10 * @returns {Promise<boolean>} Returns a promise containing true if the value valueToFind is found within the async-iterable.
11 */
12export declare function includes<T>(source: AsyncIterable<T>, valueToFind: T, fromIndex?: number, signal?: AbortSignal): Promise<boolean>;