OrderedIterable<T> Interface

    Package: @esfx/iter-ordered

    Represents an Iterable that is inherently ordered.

    Declaration
    export interface OrderedIterable<T> extends Iterable<T> 
    Inheritance
    Iterable<T>
    OrderedIterable<T>

    Methods

    [OrderedIterable.thenBy](keySelector, comparer, descending)

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

    Declaration
    [OrderedIterable.thenBy]<K>(keySelector: (element: T) => K, comparer: Comparison<K> | Comparer<K>, descending: boolean): OrderedIterable<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
    OrderedIterable<T>

    Generated by DocFX