Enumeration EVENTS

Events emitted on the Queue instance.

Example

import { Queue, EVENTS } from "queue-system";
const q = new Queue();
q.on(EVENTS.TASK_ADD, () => sendNotification("New task just got added"));

Enumeration Members

QUEUE_ORDER QUEUE_SIZE TASK_ADD TASK_END TASK_ERROR TASK_REMOVE TASK_START TASK_SUCCESS TASK_THROWN

Enumeration Members

QUEUE_ORDER

QUEUE_ORDER: "queue-order"

Emitted when the queue size is changed (task is added or removed from the queue), with a tasks list as a parameter

QUEUE_SIZE

QUEUE_SIZE: "queue-size"

Emitted when the queue size is changed (task is added or removed from the queue), with a number of tasks in it as a parameter

TASK_ADD

TASK_ADD: "task-add"

Emitted when a task is added to the queue (no matter of position)

TASK_END

TASK_END: "task-end"

Emitted when a task finishes its run

TASK_ERROR

TASK_ERROR: "task-error"

Emitted when an async task finishes its run with an error (Promise rejects)

TASK_REMOVE

TASK_REMOVE: "task-remove"

Emitted when a task is removed from the queue

TASK_START

TASK_START: "task-start"

Emitted when a task is run

TASK_SUCCESS

TASK_SUCCESS: "task-success"

Emitted when a task finishes its run with a success (Promise resolves or simply no reject for synchronous task)

TASK_THROWN

TASK_THROWN: "task-thrown"

Emitted when an sync task throws an error

Settings

Member Visibility

Theme

Generated using TypeDoc