UNPKG

788 BTypeScriptView Raw
1import { ExtremaOptions } from './extremaoptions';
2/**
3 * Returns the elements in an async-iterable sequence with the maximum key value.
4 *
5 * @export
6 * @template TSource The type of the elements in the source sequence.
7 * @template TKey The type of the key computed for each element in the source sequence.
8 * @param {AsyncIterable<TSource>} source An async-iterable sequence to get the maximum elements for.
9 * @param {ExtremaOptions<TSource, TKey>} [options] The options which include an optional comparer and abort signal.
10 * @returns {Promise<TSource[]>} A promise containing a list of zero or more elements that have a maximum key value.
11 */
12export declare function maxBy<TSource, TKey>(source: AsyncIterable<TSource>, options?: ExtremaOptions<TSource, TKey>): Promise<TSource[]>;