Interface WrappedParentIds<ParIds>

What gets returned by Stratify#parentData() when Stratify#parentIds is set.

interface WrappedParentIds<ParIds extends ParentIds> {
    wrapped: ParIds;
    (
        datum: ParIds extends ParentIds<N> ? N : never,
        index: number,
    ): undefined | Iterable<readonly [string, undefined], any, any>;
}

Type Parameters

Hierarchy (View Summary)

  • WrappedParentIds(
        datum: ParIds extends ParentIds<N> ? N : never,
        index: number,
    ): undefined | Iterable<readonly [string, undefined], any, any>

  • get parent ids and link data from a node datum

    Parameters

    • datum: ParIds extends ParentIds<N> ? N : never

      the node data to get parent ids from

    • index: number

      the order that the datum was encountered in

    Returns undefined | Iterable<readonly [string, undefined], any, any>

    parentData - the parent ids and link data that correspond to the node datum, undefined is the same as empty

Properties

wrapped

Properties

wrapped

wrapped: ParIds

the wrapped parent ids operator

Settings

Member Visibility

On This Page

Properties