HierarchyIterable Namespace

Package: @esfx/iter-hierarchy

Functions

create(iterable, provider)

Creates a HierarchyIterable using the provided HierarchyProvider.

Declaration

function create<TNode, T extends TNode = TNode>(iterable: OrderedIterable<T>, provider: HierarchyProvider<TNode>): OrderedHierarchyIterable<TNode, T>;

Type Parameters

TNode

T

Parameters

iterable

OrderedIterable<T>

An Iterable object.

provider

HierarchyProvider<TNode>

A HierarchyProvider. Hierarchy

Returns

OrderedHierarchyIterable<TNode, T>

create(iterable, provider)

Declaration

function create<TNode, T extends TNode = TNode>(iterable: Iterable<T>, provider: HierarchyProvider<TNode>): HierarchyIterable<TNode, T>;

Type Parameters

TNode

T

Parameters

iterable

Iterable<T>

provider

HierarchyProvider<TNode>

Returns

HierarchyIterable<TNode, T>

hasInstance(x)

Declaration

function hasInstance(x: unknown): x is HierarchyIterable<unknown>;

Parameters

x

unknown

Returns

x is HierarchyIterable<unknown>