AsyncOrderedIterable<T> Interface

Package: @esfx/async-iter-ordered

Represents an AsyncIterable that is inherently ordered.

Declaration

export interface AsyncOrderedIterable<T> extends AsyncIterable<T> 

Inheritance

AsyncIterable<T>

AsyncOrderedIterable<T>

Methods

[AsyncOrderedIterable.thenByAsync](keySelector, comparer, descending)

Creates a subsequent AsyncOrderedIterable whose elements are also ordered by the provided key.

Declaration

[AsyncOrderedIterable.thenByAsync]<K>(keySelector: (element: T) => K, comparer: Comparison<K> | Comparer<K>, descending: boolean): AsyncOrderedIterable<T>;

Type Parameters

K

Parameters

keySelector

(element: T) => K

A callback used to select the key for an element.

comparer

Comparison<K> | Comparer<K>

A callback used to compare two keys.

descending

boolean

A value indicating whether to sort in descending (true) or ascending (false) order.

Returns

AsyncOrderedIterable<T>