Axis Namespace

Package: @esfx/iter-hierarchy

Axis traversal helpers.

Functions

ancestors(provider, element)

Declaration

function ancestors<T>(provider: HierarchyProvider<T>, element: T): Generator<T, void, unknown>;

Type Parameters

T

Parameters

provider

HierarchyProvider<T>

element

T

Returns

Generator<T, void, unknown>

ancestorsAndSelf(provider, element)

Declaration

function ancestorsAndSelf<T>(provider: HierarchyProvider<T>, element: T): Generator<T, void, unknown>;

Type Parameters

T

Parameters

provider

HierarchyProvider<T>

element

T

Returns

Generator<T, void, unknown>

children(provider, element)

Declaration

function children<T>(provider: HierarchyProvider<T>, element: T): Generator<T, void, unknown>;

Type Parameters

T

Parameters

provider

HierarchyProvider<T>

element

T

Returns

Generator<T, void, unknown>

descendants(provider, element)

Declaration

function descendants<T>(provider: HierarchyProvider<T>, element: T): Generator<T, void, undefined>;

Type Parameters

T

Parameters

provider

HierarchyProvider<T>

element

T

Returns

Generator<T, void, undefined>

descendantsAndSelf(provider, element)

Declaration

function descendantsAndSelf<T>(provider: HierarchyProvider<T>, element: T): Generator<T, void, undefined>;

Type Parameters

T

Parameters

provider

HierarchyProvider<T>

element

T

Returns

Generator<T, void, undefined>

firstChild(provider, element)

Declaration

function firstChild<T>(provider: HierarchyProvider<T>, element: T): Generator<T, void, unknown>;

Type Parameters

T

Parameters

provider

HierarchyProvider<T>

element

T

Returns

Generator<T, void, unknown>

following(provider, element)

Declaration

function following<T>(provider: HierarchyProvider<T>, element: T): Generator<T, void, undefined>;

Type Parameters

T

Parameters

provider

HierarchyProvider<T>

element

T

Returns

Generator<T, void, undefined>

followingSiblings(provider, element)

Declaration

function followingSiblings<T>(provider: HierarchyProvider<T>, element: T): Generator<T, void, unknown>;

Type Parameters

T

Parameters

provider

HierarchyProvider<T>

element

T

Returns

Generator<T, void, unknown>

lastChild(provider, element)

Declaration

function lastChild<T>(provider: HierarchyProvider<T>, element: T): Generator<T, void, unknown>;

Type Parameters

T

Parameters

provider

HierarchyProvider<T>

element

T

Returns

Generator<T, void, unknown>

nthChild(provider, element, offset)

Declaration

function nthChild<T>(provider: HierarchyProvider<T>, element: T, offset: number | Index): Generator<T, void, unknown>;

Type Parameters

T

Parameters

provider

HierarchyProvider<T>

element

T

offset

number | Index

Returns

Generator<T, void, unknown>

parents(provider, element)

Declaration

function parents<T>(provider: HierarchyProvider<T>, element: T): Generator<T, void, unknown>;

Type Parameters

T

Parameters

provider

HierarchyProvider<T>

element

T

Returns

Generator<T, void, unknown>

preceding(provider, element)

Declaration

function preceding<T>(provider: HierarchyProvider<T>, element: T): Generator<T, void, undefined>;

Type Parameters

T

Parameters

provider

HierarchyProvider<T>

element

T

Returns

Generator<T, void, undefined>

precedingSiblings(provider, element)

Declaration

function precedingSiblings<T>(provider: HierarchyProvider<T>, element: T): Generator<T, void, unknown>;

Type Parameters

T

Parameters

provider

HierarchyProvider<T>

element

T

Returns

Generator<T, void, unknown>

root(provider, element)

Declaration

function root<T>(provider: HierarchyProvider<T>, element: T): Generator<T, void, unknown>;

Type Parameters

T

Parameters

provider

HierarchyProvider<T>

element

T

Returns

Generator<T, void, unknown>

self(provider, element)

Declaration

function self<T>(provider: HierarchyProvider<T>, element: T): Generator<T, void, unknown>;

Type Parameters

T

Parameters

provider

HierarchyProvider<T>

element

T

Returns

Generator<T, void, unknown>

siblings(provider, element)

Declaration

function siblings<T>(provider: HierarchyProvider<T>, element: T): Generator<T, void, unknown>;

Type Parameters

T

Parameters

provider

HierarchyProvider<T>

element

T

Returns

Generator<T, void, unknown>

siblingsAndSelf(provider, element)

Declaration

function siblingsAndSelf<T>(provider: HierarchyProvider<T>, element: T): Generator<T, void, unknown>;

Type Parameters

T

Parameters

provider

HierarchyProvider<T>

element

T

Returns

Generator<T, void, unknown>