bullmq - v5.56.2
    Preparing search index...

    Class Queue<DataType, ResultType, NameType>

    Queue

    This class provides methods to add jobs to a queue and some othe high-level administration such as pausing or deleting queues.

    Type Parameters

    • DataType = any
    • ResultType = any
    • NameType extends string = string

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    closing jobsOpts keys limiter name opts token toKey

    Accessors

    client defaultJobOptions redisVersion repeat

    Methods

    add addBulk clean close count disconnect drain emit getActive getActiveCount getCompleted getCompletedCount getDelayed getDelayedCount getFailed getFailedCount getJob getJobCountByTypes getJobCounts getJobLogs getJobs getMetrics getQueueEvents getQueueSchedulers getRanges getRepeatableJobs getWaiting getWaitingChildren getWaitingChildrenCount getWaitingCount getWorkers isPaused obliterate off on once pause remove removeRepeatable removeRepeatableByKey resume retryJobs trimEvents waitUntilReady

    Constructors

    Properties

    closing: Promise<void>
    jobsOpts: BaseJobOptions
    keys: KeysMap
    limiter: { groupKey: string } = null
    name: string

    The name of the queue.

    opts: QueueBaseOptions = {}

    Options for the queue.

    token: string = ...
    toKey: (type: string) => string

    Accessors

    • get redisVersion(): string

      Returns the version of the Redis instance the client is connected to,

      Returns string

    Methods

    • Cleans jobs from a queue. Similar to drain but keeps jobs within a certain grace period.

      Parameters

      • grace: number

        The grace period

      • limit: number

        Max number of jobs to clean

      • type: "wait" | "completed" | "failed" | "active" | "delayed" | "paused" = 'completed'

        The type of job to clean Possible values are completed, wait, active, paused, delayed, failed. Defaults to completed.

      Returns Promise<string[]>

      Id jobs from the deleted records

    • Returns the number of jobs waiting to be processed. This includes jobs that are "waiting" or "delayed".

      Returns Promise<number>

    • Drains the queue, i.e., removes all jobs that are waiting or delayed, but not active, completed or failed.

      Parameters

      • delayed: boolean = false

        Pass true if it should also clean the delayed jobs.

      Returns Promise<void>

    • Job counts by type

      Queue#getJobCountByTypes('completed') => completed count Queue#getJobCountByTypes('completed,failed') => completed + failed count Queue#getJobCountByTypes('completed', 'failed') => completed + failed count Queue#getJobCountByTypes('completed', 'waiting', 'failed') => completed + waiting + failed count

      Parameters

      Returns Promise<number>

    • Returns the job counts for each type specified or every list/set in the queue by default.

      Parameters

      Returns Promise<{ [index: string]: number }>

      An object, key (type) and value (count)

    • Returns the logs for a given Job.

      Parameters

      • jobId: string

        the id of the job to get the logs for.

      • start: number = 0

        zero based index from where to start returning jobs.

      • end: number = -1

        zeroo based index where to stop returning jobs.

      • asc: boolean = true

        if true, the jobs will be returned in ascending order.

      Returns Promise<{ count: number; logs: string[] }>

    • Returns the jobs that are on the given statuses (note that JobType is synonym for job status)

      Parameters

      • Optionaltypes: JobType | JobType[]

        the statuses of the jobs to return.

      • start: number = 0

        zero based index from where to start returning jobs.

      • end: number = -1

        zeroo based index where to stop returning jobs.

      • asc: boolean = false

        if true, the jobs will be returned in ascending order.

      Returns Promise<Job<DataType, ResultType, NameType>[]>

    • Get queue metrics related to the queue.

      This method returns the gathered metrics for the queue. The metrics are represented as an array of job counts per unit of time (1 minute).

      Parameters

      • type: "completed" | "failed"
      • start: number = 0

        Start point of the metrics, where 0 is the newest point to be returned.

      • end: number = -1

        End point of the metrics, where -1 is the oldest point to be returned.

      Returns Promise<Metrics>

      • Returns an object with queue metrics.

    • Get all repeatable meta jobs.

      Parameters

      • Optionalstart: number

        Offset of first job to return.

      • Optionalend: number

        Offset of last job to return.

      • Optionalasc: boolean

        Determine the order in which jobs are returned based on their next execution time.

      Returns Promise<
          {
              cron: string;
              endDate: number;
              id: string;
              key: string;
              name: string;
              next: number;
              pattern: string;
              tz: string;
          }[],
      >

    • Get the worker list related to the queue. i.e. all the known workers that are available to process jobs for this queue.

      Returns Promise<{ [index: string]: string }[]>

      • Returns an array with workers info.

    • Returns true if the queue is currently paused.

      Returns Promise<boolean>

    • Completely destroys the queue and all of its contents irreversibly. This method will the pause the queue and requires that there are no active jobs. It is possible to bypass this requirement, i.e. not having active jobs using the "force" option.

      Note: This operation requires to iterate on all the jobs stored in the queue and can be slow for very large queues.

      Parameters

      Returns Promise<void>

    • Pauses the processing of this queue globally.

      We use an atomic RENAME operation on the wait queue. Since we have blocking calls with BRPOPLPUSH on the wait queue, as long as the queue is renamed to 'paused', no new jobs will be processed (the current ones will run until finalized).

      Adding jobs requires a LUA script to check first if the paused list exist and in that case it will add it there instead of the wait list.

      Returns Promise<void>

    • Removes the given job from the queue as well as all its dependencies.

      Parameters

      • jobId: string

        The id of the job to remove

      Returns Promise<number>

      1 if it managed to remove the job or 0 if the job or any of its dependencies was locked.

    • Removes a repeatable job.

      Note: you need to use the exact same repeatOpts when deleting a repeatable job than when adding it.

      Parameters

      Returns Promise<boolean>

      removeRepeatableByKey

    • Removes a repeatable job by its key. Note that the key is the one used to store the repeatable job metadata and not one of the job iterations themselves. You can use "getRepeatableJobs" in order to get the keys.

      Parameters

      • key: string

        to the repeatable job.

      Returns Promise<boolean>

      getRepeatableJobs

    • Resumes the processing of this queue globally.

      The method reverses the pause operation by resuming the processing of the queue.

      Returns Promise<void>

    • Retry all the failed jobs.

      Parameters

      • opts: { count?: number; state?: FinishedStatus; timestamp?: number } = {}

        contains number to limit how many jobs will be moved to wait status per iteration, state (failed, completed) failed by default or from which timestamp.

      Returns Promise<void>

    • Trim the event stream to an approximately maxLength.

      Parameters

      • maxLength: number

      Returns Promise<number>

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods