Grouping Class

    Package: @esfx/iter-grouping

    Represents a group of values associated with the same key.

    Declaration
    export declare class Grouping<K, V> implements Iterable<V> 

    Constructors

    constructor(key, values)

    Constructs a new instance of the Grouping class

    Declaration
    constructor(key: K, values: Iterable<V>);
    Parameters
    key
    K

    values
    Iterable<V>

    Properties

    key

    The key associated with this group.

    Declaration
    readonly key: K;
    Property Value
    K

    values

    The values in the group.

    Declaration
    readonly values: Iterable<V>;
    Property Value
    Iterable<V>

    Methods

    [Symbol.iterator]()

    Declaration
    [Symbol.iterator](): Iterator<V, any, undefined>;
    Returns
    Iterator<V, any, undefined>

    from(key, values, provider)

    Declaration
    static from<K, VNode, V extends VNode>(key: K, values: Iterable<V>, provider: HierarchyProvider<VNode>): HierarchyGrouping<K, VNode, V>;
    Type Parameters
    K

    VNode

    V

    Parameters
    key
    K

    values
    Iterable<V>

    provider
    HierarchyProvider<VNode>

    Returns
    HierarchyGrouping<K, VNode, V>

    from(key, values)

    Declaration
    static from<K, VNode, V extends VNode>(key: K, values: HierarchyIterable<VNode, V>): HierarchyGrouping<K, VNode, V>;
    Type Parameters
    K

    VNode

    V

    Parameters
    key
    K

    values
    HierarchyIterable<VNode, V>

    Returns
    HierarchyGrouping<K, VNode, V>

    from(key, values)

    Declaration
    static from<K, V>(key: K, values: Iterable<V>): Grouping<K, V>;
    Type Parameters
    K

    V

    Parameters
    key
    K

    values
    Iterable<V>

    Returns
    Grouping<K, V>

    Generated by DocFX