ixfx
    Preparing search index...

    Module @ixfx/collections - v0.48.0

    Contains data structures for storing and accessing data.

    Namespaces

    Graphs

    Undirected and directed graphs and associated algorithms.

    Maps

    Maps associate keys with values.

    Queues

    Queues store items in the order in which they are added.

    Sets

    Sets store unique items.

    Stacks

    Stacks store items in order, like a stack of plates.

    Trees

    A tree-like structure of branches and leaves.

    Classes

    CircularArray

    A circular array keeps a maximum number of values, overwriting older values as needed. Immutable.

    ExpiringMap

    A map that can have a capacity limit. The elapsed time for each get/set operation is maintained allowing for items to be automatically removed. has() does not affect the last access time.

    QueueImmutable

    Queue (immutable). See also QueueMutable.

    QueueMutable

    Mutable queue that fires events when manipulated.

    Table

    Stores values in a table of rows (vertical) and columns (horizontal)

    Interfaces

    ICircularArray
    ISetImmutable

    A Set which stores unique items determined by their value, rather than object reference (unlike the default JS Set). Create with Sets.mutable. Immutable.

    ISetMutable

    A Set which stores unique items determined by their value, rather than object reference (unlike the default JS Set). Create with Sets.mutable. Mutable.

    References

    IStackImmutable → Stacks.IStackImmutable
    MapOfSimpleMutable → Maps.MapOfSimpleMutable
    SetStringImmutable → Sets.SetStringImmutable
    SetStringMutable → Sets.SetStringMutable
    StackImmutable → Stacks.StackImmutable
    StackMutable → Stacks.StackMutable

    Type Aliases

    ArrayKeys

    Key-value pairs in an array

    EitherKey

    Type that represents key-values in object or array form

    LabelledNode

    A node with an accompanying label

    LabelledSingleValue

    A value that is labelled

    LabelledValue

    A labelled single value or array of values

    LabelledValues

    A label for any number of values

    ObjectKeys

    Key-value pairs in object form

    QueueDiscardPolicy
    QueueOpts

    Queue options.

    SimplifiedNode
    TableRow

    A row of table values

    TableValue

    A table value or undefined

    TraversableTree

    Traversable Tree

    TraverseObjectEntry
    TraverseObjectEntryStatic
    TraverseObjectEntryWithAncestors
    TraverseObjectPathOpts

    Options for parsing a path

    TreeNode

    Array-backed tree node.

    ValueSetEventMap
    WrappedNode

    Wraps a TreeNode for a more object-oriented means of access.