Fake Mirrors
    Preparing search index...

    Interface BaseQueue

    Represents a base queue.

    interface BaseQueue {
        close(): Promise<void>;
        getJobCount(): Promise<number>;
        getWorkers(): Promise<object[]>;
    }

    Hierarchy (View Summary)

    Implemented by

    • Gracefully closes the queue.

      This method should be called during application shutdown.

      Returns Promise<void>

      LifecycleError If the queue cannot be closed properly.

    • Retrieves the total number of jobs in the queue.

      Returns Promise<number>

      The total job count.

      ProducerError If the count cannot be retrieved.

    • Retrieves the workers for the queue.

      Returns Promise<object[]>

      The queue workers list.

      ProducerError If the workers cannot be retrieved.

    Methods