Namespace Collections

This module includes a variety of techniques for storing and retrieving data.

Ranked collections

Queues

A queue has the logic of waiting in line at the bakery. First in, first out.

• Queues.immutable: Create a immutable queue.
• Queues.mutable: Create a mutable queue. Has events that fire when queue is manipulated.
• Queues.priority: Create a priority queue

Stacks

A stack has the logic of stacked plates. First in, last out.

• Stacks.immutable: Create a immutable queue.
• Stacks.mutable: Create a mutable stack.

Sets

Like a regular array, a set can store many items. However, duplicate items are ignored - it only keeps unique items. ixfx's Sets.ISetMutable allows for considering items as identical by value, not just by reference as the default JS Set operates

• Sets.mutable: Create a mutable set.
• Sets.immutable: Create an immutable set.
• Sets.MassiveSet: Regular JS sets have a restriction on capacity. This implementation can store more.

Maps

• Maps.immutable: Create a immutable map.
• Maps.mutable: Create a mutable map.
• ExpiringMap: A map that can have a capacity limit and automatically expire key/value pairs.
• Maps.NumberMap: A map that associates keys with numeric values, including some helper functions.
• Maps.ofArrayMutable: Stores multiple values for a key in an array.
• Maps.ofCircularMutable: Stores multiple values for a key in a circular array.
• Maps.ofSetMutable: Stores multiple values for a key in a Set.

Trees

• Trees.Mutable.root: Create a root tree node
• Trees.Mutable.rootWrapped: Create a root tree node for object-oriented access
• Trees.FromObject.create: Create a tree structure from the basis of an object's structure.
• Trees.FromObject.createWrapped: Create a tree structure from the basis of an object's structure, wrapped for object-oriented access.

Graphs

• Graphs.Directed
• Graphs.Undirected

Etc

• Table
• circularArray

Example: Importing

// If library is stored two directories up under `ixfx/`
import {map} from '../../ixfx/dist/collections.js';
// Import from web
import {map} from 'https://unpkg.com/ixfx/dist/collections.js'
Copy