AsyncHierarchyIterable Namespace

    Package: @esfx/async-iter-hierarchy

    Functions

    create(iterable, provider)

    Creates an AsyncHierarchyIterable using the provided HierarchyProvider.

    Declaration
    function create<TNode, T extends TNode = TNode>(iterable: AsyncOrderedIterable<T> | OrderedIterable<T>, provider: HierarchyProvider<TNode>): AsyncOrderedHierarchyIterable<TNode, T>;
    Type Parameters
    TNode

    T

    Parameters
    iterable
    AsyncOrderedIterable<T> | OrderedIterable<T>

    provider
    HierarchyProvider<TNode>

    Returns
    AsyncOrderedHierarchyIterable<TNode, T>

    create(iterable, provider)

    Declaration
    function create<TNode, T extends TNode = TNode>(iterable: AsyncIterable<T> | Iterable<PromiseLike<T> | T>, provider: HierarchyProvider<TNode>): AsyncHierarchyIterable<TNode, T>;
    Type Parameters
    TNode

    T

    Parameters
    iterable
    AsyncIterable<T> | Iterable<PromiseLike<T> | T>

    provider
    HierarchyProvider<TNode>

    Returns
    AsyncHierarchyIterable<TNode, T>

    hasInstance(x)

    Declaration
    function hasInstance(x: unknown): x is AsyncHierarchyIterable<unknown>;
    Parameters
    x
    unknown

    Returns
    x is AsyncHierarchyIterable<unknown>

    Generated by DocFX