ixfx
    Preparing search index...

    Class QueueMutable<V>

    Mutable queue that fires events when manipulated.

    Queues are useful if you want to treat 'older' or 'newer' items differently. Enqueing adds items at the back of the queue, while dequeing removes items from the front (ie. the oldest).

    const q = Queues.mutable();       // Create
    q.enqueue(`a`, `b`);     // Add two strings
    const front = q.dequeue();  // `a` is at the front of queue (oldest)

    Example: Cap size to 5 items, throwing away newest items already in queue.

    const q = Queues.mutable({capacity: 5, discardPolicy: `newer`});

    Events can be used to monitor data flows.

    • 'enqueue': fires when item(s) are added
    • 'dequeue': fires when an item is dequeued from front
    • 'removed': fires when an item is dequeued, queue is cleared or .removeWhere is used to trim queue

    Each of the event handlers return the state of the queue as the 'finalData' field.

    q.addEventListener(`enqueue`, e => {
     // e.added, e.finalData
    });
    q.addEventListener(`removed`, e => {
     // e.removed, e.finalData
    });
    q.addEventListener(`dequeue`, e=> {
     // e.removed, e.finalData
    })

    Type Parameters

    • V

      Data type of items

    Hierarchy (View Summary)

    Implements

    Constructors

    constructor

    Properties

    data eq options

    Accessors

    isDisposed isEmpty isFull length peek

    Methods

    addEventListener at clear dequeue dispose enqueue fireEvent onClear onEnqueue onRemoved removeEventListener removeWhere toArray

    Constructors

    constructor

    Properties

    data

    data: readonly V[]

    eq

    eq: IsEqual<V>

    Readonlyoptions

    options: QueueOpts<V>

    Accessors

    isDisposed

    • get isDisposed(): boolean

      Returns boolean

    isEmpty

    • get isEmpty(): boolean

      Returns true if queue is empty

      Returns boolean

    isFull

    • get isFull(): boolean

      Is queue full? Returns false if no capacity has been set

      Returns boolean

    length

    • get length(): number

      Number of items in queue

      Returns number

    peek

    • get peek(): undefined | V

      Returns front of queue (oldest item), or undefined if queue is empty

      Returns undefined | V

    Methods

    addEventListener

    at

    • at(index: number): V

      Returns the item at given rank (0 being front of queue)

      Parameters

      • index: number

      Returns V

    clear

    dequeue

    • dequeue(): undefined | V

      Dequeues (removes oldest item / item at front of queue)

      Use peek to look at the item at front of queue without removing it.

      Returns undefined | V

      Item, or undefined if queue is empty

    dispose

    enqueue

    • enqueue(...toAdd: readonly V[]): number

      Enqueues (adds items to back of queue). If a capacity is set, not all items might be added.

      Parameters

      • ...toAdd: readonly V[]

      Returns number

      How many items were added

    ProtectedfireEvent

    ProtectedonClear

    • onClear(): void

      Called when all data is cleared

      Returns void

    ProtectedonEnqueue

    • onEnqueue(result: readonly V[], attemptedToAdd: readonly V[]): void

      Parameters

      • result: readonly V[]
      • attemptedToAdd: readonly V[]

      Returns void

    ProtectedonRemoved

    • onRemoved(removed: readonly V[], finalData: readonly V[]): void

      Parameters

      • removed: readonly V[]
      • finalData: readonly V[]

      Returns void

    removeEventListener

    removeWhere

    • removeWhere(predicate: (item: V) => boolean): number

      Removes values that match predicate.

      Parameters

      • predicate: (item: V) => boolean

      Returns number

      Returns number of items removed.

    toArray

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods