AsyncOrderedHierarchyIterable<TNode, T> Interface

    Package: @esfx/async-iter-hierarchy

    Represents an AsyncIterable with a navigable hierarchy that is inherently ordered.

    Declaration
    export interface AsyncOrderedHierarchyIterable<TNode, T extends TNode = TNode> extends AsyncOrderedIterable<T>, AsyncHierarchyIterable<TNode, T> 
    Inheritance
    AsyncOrderedIterable<T>
    AsyncHierarchyIterable<TNode, T>
    AsyncOrderedHierarchyIterable<TNode, T>
    Inherited Members
    [AsyncOrderedIterable.thenByAsync](keySelector, comparer, descending)

    Methods

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

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

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

    Generated by DocFX