OrderedHierarchyIterable<TNode, T> Interface

Package: @esfx/iter-hierarchy

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

Declaration

export interface OrderedHierarchyIterable<TNode, T extends TNode = TNode> extends OrderedIterable<T>, HierarchyIterable<TNode, T> 

Inheritance

OrderedIterable<T>

HierarchyIterable<TNode, T>

OrderedHierarchyIterable<TNode, T>

Inherited Members

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

Methods

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

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

Declaration

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

OrderedHierarchyIterable<TNode, T>