Class Queue<DataType, ResultType, NameType>

Queue

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

Type Parameters

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

Hierarchy (view full)

Constructors

constructor

Properties

closing jobsOpts keys name opts qualifiedName toKey token

Accessors

client defaultJobOptions metaValues redisVersion repeat

Methods

add addBulk addJobLog clean close count disconnect drain emit getActive getActiveCount getCompleted getCompletedCount getDelayed getDelayedCount getDependencies getFailed getFailedCount getJob getJobCountByTypes getJobCounts getJobLogs getJobState getJobs getMetrics getPrioritized getPrioritizedCount getQueueEvents getRanges getRateLimitTtl getRepeatableJobs getWaiting getWaitingChildren getWaitingChildrenCount getWaitingCount getWorkers getWorkersCount isPaused obliterate off on once pause promoteJobs remove removeDeprecatedPriorityKey removeRepeatable removeRepeatableByKey resume retryJobs trimEvents updateJobProgress waitUntilReady

Constructors

constructor

Properties

closing

closing: Promise<void>

jobsOpts

jobsOpts: BaseJobOptions

keys

keys: KeysMap

Readonly name

name: string

The name of the queue.

opts

opts: QueueOptions

Options for the queue.

Readonly qualifiedName

qualifiedName: string

toKey

toKey: ((type) => string)

Type declaration

    • (type): string

    • Parameters

      • type: string

      Returns string

token

token: string = ...

Accessors

client

defaultJobOptions

metaValues

  • get metaValues(): Record<string, string | number>

  • Returns Record<string, string | number>

redisVersion

  • get redisVersion(): string

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

    Returns string

repeat

Methods

add

addBulk

addJobLog

  • addJobLog(jobId, logRow, keepLogs?): Promise<number>

  • Logs one row of job's log data.

    Parameters

    • jobId: string

      The job id to log against.

    • logRow: string

      String with log data to be logged.

    • Optional keepLogs: number

      Max number of log entries to keep (0 for unlimited).

    Returns Promise<number>

    The total number of log entries for this job so far.

clean

  • clean(grace, limit, type?): Promise<string[]>

  • 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: "failed" | "active" | "paused" | "completed" | "wait" | "prioritized" | "delayed" = '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

close

count

  • count(): Promise<number>

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

    Returns Promise<number>

disconnect

drain

  • drain(delayed?): Promise<void>

  • 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>

emit

getActive

getActiveCount

getCompleted

getCompletedCount

getDelayed

getDelayedCount

getDependencies

  • getDependencies(parentId, type, start, end): Promise<{
        items: {
            err?: string;
            id: string;
            v?: any;
        }[];
        jobs: JobJsonRaw[];
        total: number;
    }>

  • Returns the qualified job ids and the raw job data (if available) of the children jobs of the given parent job. It is possible to get either the already processed children, in this case an array of qualified job ids and their result values will be returned, or the pending children, in this case an array of qualified job ids will be returned. A qualified job id is a string representing the job id in a given queue, for example: "bull:myqueue:jobid".

    Parameters

    • parentId: string

      The id of the parent job

    • type: "pending" | "processed"

      "processed" | "pending"

    • start: number
    • end: number

    Returns Promise<{
        items: {
            err?: string;
            id: string;
            v?: any;
        }[];
        jobs: JobJsonRaw[];
        total: number;
    }>

getFailed

getFailedCount

getJob

getJobCountByTypes

  • getJobCountByTypes(...types): Promise<number>

  • 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>

getJobCounts

  • getJobCounts(...types): Promise<{
        [index: string]: 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)

getJobLogs

  • getJobLogs(jobId, start?, end?, asc?): Promise<{
        count: number;
        logs: string[];
    }>

  • 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

      zero 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[];
    }>

getJobState

getJobs

getMetrics

  • getMetrics(type, start?, end?): Promise<Metrics>

  • 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: "failed" | "completed"
    • 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.

getPrioritized

getPrioritizedCount

getQueueEvents

  • getQueueEvents(): Promise<{
        [index: string]: string;
    }[]>

  • Get queue events list related to the queue. Note: GCP does not support SETNAME, so this call will not work

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

    • Returns an array with queue events info.

    Deprecated

    do not use this method, it will be removed in the future.

getRanges

getRateLimitTtl

getRepeatableJobs

  • getRepeatableJobs(start?, end?, asc?): Promise<RepeatableJob[]>

  • Get all repeatable meta jobs.

    Parameters

    • Optional start: number

      Offset of first job to return.

    • Optional end: number

      Offset of last job to return.

    • Optional asc: boolean

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

    Returns Promise<RepeatableJob[]>

getWaiting

getWaitingChildren

getWaitingChildrenCount

getWaitingCount

getWorkers

  • getWorkers(): Promise<{
        [index: string]: string;
    }[]>

  • Get the worker list related to the queue. i.e. all the known workers that are available to process jobs for this queue. Note: GCP does not support SETNAME, so this call will not work

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

    • Returns an array with workers info.

getWorkersCount

isPaused

  • isPaused(): Promise<boolean>

  • Returns true if the queue is currently paused.

    Returns Promise<boolean>

obliterate

  • obliterate(opts?): Promise<void>

  • 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>

off

on

once

pause

  • pause(): 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>

promoteJobs

  • promoteJobs(opts?): Promise<void>

  • Promote all the delayed jobs.

    Parameters

    • opts: {
          count?: number;
      } = {}
      • Optional count?: number

    Returns Promise<void>

remove

  • remove(jobId, opts?): Promise<number>

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

    Parameters

    • jobId: string

      The id of the job to remove

    • opts: {
          removeChildren: boolean;
      } = {}

      Options to remove a job

      • removeChildren: boolean

    Returns Promise<number>

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

removeDeprecatedPriorityKey

  • removeDeprecatedPriorityKey(): Promise<number>

  • Delete old priority helper key.

    Returns Promise<number>

removeRepeatable

  • removeRepeatable(name, repeatOpts, jobId?): Promise<boolean>

  • 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>

    See

    removeRepeatableByKey

removeRepeatableByKey

  • removeRepeatableByKey(key): Promise<boolean>

  • 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

    Returns Promise<boolean>

    See

    getRepeatableJobs

resume

  • resume(): Promise<void>

  • Resumes the processing of this queue globally.

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

    Returns Promise<void>

retryJobs

  • retryJobs(opts?): Promise<void>

  • Retry all the failed or completed jobs.

    Parameters

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

    Returns Promise<void>

trimEvents

  • trimEvents(maxLength): Promise<number>

  • Trim the event stream to an approximately maxLength.

    Parameters

    • maxLength: number

    Returns Promise<number>

updateJobProgress

  • updateJobProgress(jobId, progress): Promise<void>

  • Updates the given job's progress.

    Parameters

    • jobId: string

      The id of the job to update

    • progress: number | object

      Number or object to be saved as progress.

    Returns Promise<void>

waitUntilReady

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc