Class QueueGetters<JobBase>

Provides different getters for different aspects of a queue.

Type Parameters

JobBase extends Job = Job

Hierarchy (View Summary)

QueueBase
- QueueGetters
  - Queue

Constructors

constructor

new QueueGetters<
    JobBase extends Job<any, any, string, JobBase> = Job<any, any, string>,
>(
    name: string,
    opts?: QueueBaseOptions,
    Connection?: typeof RedisConnection,
    hasBlockingConnection?: boolean,
): QueueGetters<JobBase>
Type Parameters
- JobBase extends Job<any, any, string, JobBase> = Job<any, any, string>
Parameters
- name: string
  The name of the queue.
- opts: QueueBaseOptions = ...
  Options for the queue.
- Connection: typeof RedisConnection = RedisConnection
  An optional "Connection" class used to instantiate a Connection. This is useful for testing with mockups and/or extending the Connection class and passing an alternate implementation.
- hasBlockingConnection: boolean = false
Returns QueueGetters<JobBase>
Inherited from QueueBase.constructor
- Defined in classes/queue-base.ts:42

Properties

closing

closing: Promise<void>

keys

keys: KeysMap

`Readonly`name

name: string

The name of the queue.

opts

opts: QueueBaseOptions = ...

Options for the queue.

`Readonly`qualifiedName

qualifiedName: string

toKey

toKey: (type: string) => string

Accessors

client

get client(): Promise<RedisClient>
Returns a promise that resolves to a redis client. Normally used only by subclasses.

Returns Promise<RedisClient>
Inherited from QueueBase.client
- Defined in classes/queue-base.ts:88

redisVersion

get redisVersion(): string
Returns the version of the Redis instance the client is connected to,

Returns string
Inherited from QueueBase.redisVersion
- Defined in classes/queue-base.ts:99

Methods

close

close(): Promise<void>
Closes the connection and returns a promise that resolves when the connection is closed.

Returns Promise<void>
Inherited from QueueBase.close
- Defined in classes/queue-base.ts:148

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>
- Defined in classes/queue-getters.ts:73

disconnect

disconnect(): Promise<void>
Force disconnects a connection.

Returns Promise<void>
Inherited from QueueBase.disconnect
- Defined in classes/queue-base.ts:160

emit

emit(event: string | symbol, ...args: any[]): boolean
Emits an event. Normally used by subclasses to emit events.
Parameters
- event: string | symbol
  The emitted event.
- ...args: any[]
Returns boolean
Inherited from QueueBase.emit
- Defined in classes/queue-base.ts:117

exportPrometheusMetrics

exportPrometheusMetrics(
globalVariables?: Record<string, string>,
): Promise<string>
Export the metrics for the queue in the Prometheus format. Automatically exports all the counts returned by getJobCounts().
Parameters
- OptionalglobalVariables: Record<string, string>
Returns Promise<string>
- Returns a string with the metrics in the Prometheus format.
See
https://prometheus.io/docs/instrumenting/exposition_formats/
- Defined in classes/queue-getters.ts:582

getActive

getActive(start?: number, end?: number): Promise<JobBase[]>
Returns the jobs that are in the "active" status.
Parameters
- start: number = 0
  zero based index from where to start returning jobs.
- end: number = -1
  zero based index where to stop returning jobs.
Returns Promise<JobBase[]>
- Defined in classes/queue-getters.ts:254

getActiveCount

getActiveCount(): Promise<number>
Returns the number of jobs in active status.

Returns Promise<number>
- Defined in classes/queue-getters.ts:188

getCompleted

getCompleted(start?: number, end?: number): Promise<JobBase[]>
Returns the jobs that are in the "completed" status.
Parameters
- start: number = 0
  zero based index from where to start returning jobs.
- end: number = -1
  zero based index where to stop returning jobs.
Returns Promise<JobBase[]>
- Defined in classes/queue-getters.ts:281

getCompletedCount

getCompletedCount(): Promise<number>
Returns the number of jobs in completed status.

Returns Promise<number>
- Defined in classes/queue-getters.ts:167

getCountsPerPriority

getCountsPerPriority(priorities: number[]): Promise<{ [index: string]: number }>
Returns the number of jobs per priority.
Parameters
- priorities: number[]
Returns Promise<{ [index: string]: number }>
- Defined in classes/queue-getters.ts:202

getDebounceJobId

getDebounceJobId(id: string): Promise<string>
Get jobId that starts debounced state.
Parameters
- id: string
  debounce identifier
Returns Promise<string>
Deprecated
use getDeduplicationJobId method
- Defined in classes/queue-getters.ts:103

getDeduplicationJobId

getDeduplicationJobId(id: string): Promise<string>
Get jobId from deduplicated state.
Parameters
- id: string
  deduplication identifier
Returns Promise<string>
- Defined in classes/queue-getters.ts:114

getDelayed

getDelayed(start?: number, end?: number): Promise<JobBase[]>
Returns the jobs that are in the "delayed" status.
Parameters
- start: number = 0
  zero based index from where to start returning jobs.
- end: number = -1
  zero based index where to stop returning jobs.
Returns Promise<JobBase[]>
- Defined in classes/queue-getters.ts:263

getDelayedCount

getDelayedCount(): Promise<number>
Returns the number of jobs in delayed status.

Returns Promise<number>
- Defined in classes/queue-getters.ts:181

getDependencies

getDependencies(
    parentId: string,
    type: "pending" | "processed",
    start: number,
    end: number,
): 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;
    },
>
an object with the following shape: { items: { id: string, v?: any, err?: string } [], jobs: JobJsonRaw[], total: number}
- Defined in classes/queue-getters.ts:311

getFailed

getFailed(start?: number, end?: number): Promise<JobBase[]>
Returns the jobs that are in the "failed" status.
Parameters
- start: number = 0
  zero based index from where to start returning jobs.
- end: number = -1
  zero based index where to stop returning jobs.
Returns Promise<JobBase[]>
- Defined in classes/queue-getters.ts:290

getFailedCount

getFailedCount(): Promise<number>
Returns the number of jobs in failed status.

Returns Promise<number>
- Defined in classes/queue-getters.ts:174

getJob

getJob(jobId: string): Promise<JobBase>
Parameters
- jobId: string
Returns Promise<JobBase>
- Defined in classes/queue-getters.ts:14

getJobCountByTypes

getJobCountByTypes(...types: JobType[]): 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
- ...types: JobType[]
Returns Promise<number>
- Defined in classes/queue-getters.ts:128

getJobCounts

getJobCounts(...types: JobType[]): Promise<{ [index: string]: number }>
Returns the job counts for each type specified or every list/set in the queue by default.
Parameters
- ...types: JobType[]
Returns Promise<{ [index: string]: number }>
An object, key (type) and value (count)
- Defined in classes/queue-getters.ts:138

getJobLogs

getJobLogs(
    jobId: string,
    start?: number,
    end?: number,
    asc?: boolean,
): 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[] }>
- Defined in classes/queue-getters.ts:403

getJobs

getJobs(
    types?: JobType | JobType[],
    start?: number,
    end?: number,
    asc?: boolean,
): Promise<JobBase[]>
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
  zero based index where to stop returning jobs.
- asc: boolean = false
  if true, the jobs will be returned in ascending order.
Returns Promise<JobBase[]>
- Defined in classes/queue-getters.ts:381

getJobState

getJobState(jobId: string): Promise<"unknown" | JobState>
Get current job state.
Parameters
- jobId: string
  job identifier.
Returns Promise<"unknown" | JobState>
Returns one of these values: 'completed', 'failed', 'delayed', 'active', 'waiting', 'waiting-children', 'unknown'.
- Defined in classes/queue-getters.ts:160

getMetrics

getMetrics(
    type: "failed" | "completed",
    start?: number,
    end?: number,
): 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.
- Defined in classes/queue-getters.ts:513

getPrioritized

getPrioritized(start?: number, end?: number): Promise<JobBase[]>
Returns the jobs that are in the "prioritized" status.
Parameters
- start: number = 0
  zero based index from where to start returning jobs.
- end: number = -1
  zero based index where to stop returning jobs.
Returns Promise<JobBase[]>
- Defined in classes/queue-getters.ts:272

getPrioritizedCount

getPrioritizedCount(): Promise<number>
Returns the number of jobs in prioritized status.

Returns Promise<number>
- Defined in classes/queue-getters.ts:195

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.
- Defined in classes/queue-getters.ts:490

getRanges

getRanges(
    types: JobType[],
    start?: number,
    end?: number,
    asc?: boolean,
): Promise<string[]>
Parameters
- types: JobType[]
- start: number = 0
- end: number = 1
- asc: boolean = false
Returns Promise<string[]>
- Defined in classes/queue-getters.ts:338

getRateLimitTtl

getRateLimitTtl(maxJobs?: number): Promise<number>
Returns the time to live for a rate limited key in milliseconds.
Parameters
- OptionalmaxJobs: number
  max jobs to be considered in rate limit state. If not passed it will return the remaining ttl without considering if max jobs is excedeed.
Returns Promise<number>
-2 if the key does not exist. -1 if the key exists but has no associated expire.

See
https://redis.io/commands/pttl/
- Defined in classes/queue-getters.ts:93

getWaiting

getWaiting(start?: number, end?: number): Promise<JobBase[]>
Returns the jobs that are in the "waiting" status.
Parameters
- start: number = 0
  zero based index from where to start returning jobs.
- end: number = -1
  zero based index where to stop returning jobs.
Returns Promise<JobBase[]>
- Defined in classes/queue-getters.ts:235

getWaitingChildren

getWaitingChildren(start?: number, end?: number): Promise<JobBase[]>
Returns the jobs that are in the "waiting-children" status. I.E. parent jobs that have at least one child that has not completed yet.
Parameters
- start: number = 0
  zero based index from where to start returning jobs.
- end: number = -1
  zero based index where to stop returning jobs.
Returns Promise<JobBase[]>
- Defined in classes/queue-getters.ts:245

getWaitingChildrenCount

getWaitingChildrenCount(): Promise<number>
Returns the number of jobs in waiting-children status.

Returns Promise<number>
- Defined in classes/queue-getters.ts:226

getWaitingCount

getWaitingCount(): Promise<number>
Returns the number of jobs in waiting or paused statuses.

Returns Promise<number>
- Defined in classes/queue-getters.ts:219

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.
- Defined in classes/queue-getters.ts:455

getWorkersCount

getWorkersCount(): Promise<number>
Returns the current count of workers for the queue.

getWorkersCount(): Promise

Returns Promise<number>
- Defined in classes/queue-getters.ts:477

trace

trace<T>(
    spanKind: SpanKind,
    operation: string,
    destination: string,
    callback: (span?: Span, dstPropagationMetadata?: string) => T | Promise<T>,
    srcPropagationMetadata?: string,
): Promise<T | Promise<T>>
Wraps the code with telemetry and provides a span for configuration.
Type Parameters
- T
Parameters
- spanKind: SpanKind
  kind of the span: Producer, Consumer, Internal
- operation: string
  operation name (such as add, process, etc)
- destination: string
  destination name (normally the queue name)
- callback: (span?: Span, dstPropagationMetadata?: string) => T | Promise<T>
  code to wrap with telemetry
- OptionalsrcPropagationMetadata: string
Returns Promise<T | Promise<T>>
Inherited from QueueBase.trace
- Defined in classes/queue-base.ts:193

waitUntilReady

waitUntilReady(): Promise<RedisClient>
Returns Promise<RedisClient>
Inherited from QueueBase.waitUntilReady
- Defined in classes/queue-base.ts:131

Class QueueGetters<JobBase>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns QueueGetters<JobBase>

Properties

closing

keys

Readonlyname

opts

ReadonlyqualifiedName

toKey

Accessors

client

Returns Promise<RedisClient>

redisVersion

Returns string

Methods

close

Returns Promise<void>

count

Returns Promise<number>

disconnect

Returns Promise<void>

emit

Parameters

Returns boolean

exportPrometheusMetrics

Parameters

Returns Promise<string>

See

getActive

Parameters

Returns Promise<JobBase[]>

getActiveCount

Returns Promise<number>

getCompleted

Parameters

Returns Promise<JobBase[]>

getCompletedCount

Returns Promise<number>

getCountsPerPriority

Parameters

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

getDebounceJobId

Parameters

Returns Promise<string>

Deprecated

getDeduplicationJobId

Parameters

Returns Promise<string>

getDelayed

Parameters

Returns Promise<JobBase[]>

getDelayedCount

Returns Promise<number>

getDependencies

Parameters

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

getFailed

Parameters

Returns Promise<JobBase[]>

getFailedCount

Returns Promise<number>

getJob

Parameters

Returns Promise<JobBase>

getJobCountByTypes

Parameters

Returns Promise<number>

getJobCounts

Parameters

`Readonly`name

`Readonly`qualifiedName

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