bunqueue v2.9 API referenceall versions · guide
bunqueue
    Preparing search index...

    Class QueueGroup

    QueueGroup provides namespace isolation for queues. All queues in a group share a common prefix.

    const billing = new QueueGroup('billing');

    const invoices = billing.getQueue('invoices');
    const payments = billing.getQueue('payments');

    // Creates queues: "billing:invoices", "billing:payments"

    billing.pauseAll(); // Pauses all billing queues
    Index
    constructor
    prefix
    drainAll drainAllAsync getQueue getWorker listQueues listQueuesAsync obliterateAll obliterateAllAsync pauseAll pauseAllAsync resumeAll resumeAllAsync
    prefix: string

    • Drain all queues in this group (remove waiting jobs)

      Returns void

    • Drain waiting jobs from every queue and return the aggregate count.

      Returns Promise<number>

    • List queues created through this group, including remote queues.

      Returns Promise<string[]>

    • Obliterate all queues in this group (remove all data)

      Returns void

    • Remove all data from every queue created through this group.

      Returns Promise<void>

    • Pause every queue created through this group.

      Returns Promise<void>

    • Resume every queue created through this group.

      Returns Promise<void>

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Methods