ixfx
    Preparing search index...

    Class TaskQueueMutable

    Simple task queue. Each task is awaited and run in turn.

    The TaskQueueMutable is shared across your code, so you don't create it directly. Rather, use:

    import { TaskQueueMutable } from "https://unpkg.com/ixfx/dist/flow.js"
    const queue = TaskQueueMutable.shared;

    Example: Usage

    import { TaskQueueMutable, sleep } from "https://unpkg.com/ixfx/dist/flow.js"
    const queue = TaskQueueMutable.shared;
    q.enqueue(async () => {
     // Takes one second to run
     await sleep(1000);
    });

    You can listen to events from the TaskQueue:

    TaskQueueMutable.shared.addEventListener(`started`, () => {
     // Queue was empty, now started processing
    });

    TaskQueueMutable.shared.addEventListener(`empty`, () => {
     // Queue has finished processing all items
    });

    Hierarchy (View Summary)

    Properties

    shared

    Accessors

    isDisposed isEmpty length

    Methods

    addEventListener clear dequeue dispose enqueue fireEvent removeEventListener

    Properties

    Static Readonlyshared

    shared: TaskQueueMutable = ...

    Accessors

    isDisposed

    • get isDisposed(): boolean

      Returns boolean

    isEmpty

    • get isEmpty(): boolean

      Returns true if queue is empty

      Returns boolean

    length

    • get length(): number

      Number of items in queue

      Returns number

    Methods

    addEventListener

    clear

    • clear(): void

      Clears all tasks, and stops any scheduled processing. Currently running tasks will continue.

      Returns void

    dequeue

    dispose

    enqueue

    • enqueue(task: () => Promise<void>): number

      Adds a task. This triggers processing loop if not already started.

      queue.add(async () => {
       await sleep(1000);
      });

      Parameters

      • task: () => Promise<void>

        Task to run

      Returns number

    ProtectedfireEvent

    removeEventListener

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods