Class QueueGetters<DataType, ResultType, NameType>

Description

Provides different getters for different aspects of a queue.

Type Parameters

  • DataType
  • ResultType
  • NameType extends string

Hierarchy (view full)

Constructors

constructor

Properties

closing keys name opts toKey

Accessors

client redisVersion

Methods

close count disconnect emit getActive getActiveCount getCompleted getCompletedCount getDelayed getDelayedCount getFailed getFailedCount getJob getJobCountByTypes getJobCounts getJobLogs getJobState getJobs getMetrics getQueueEvents getRanges getWaiting getWaitingChildren getWaitingChildrenCount getWaitingCount getWorkers waitUntilReady

Constructors

constructor

  • new QueueGetters<DataType, ResultType, NameType>(name, opts?, Connection?): QueueGetters<DataType, ResultType, NameType>

  • Type Parameters

    • DataType
    • ResultType
    • NameType extends 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.

    Returns QueueGetters<DataType, ResultType, NameType>

Properties

closing

closing: Promise<void>

keys

keys: KeysMap

Readonly name

name: string

The name of the queue.

opts

opts: QueueBaseOptions = {}

Options for the queue.

toKey

toKey: ((type) => string)

Type declaration

    • (type): string

    • Parameters

      • type: string

      Returns string

Accessors

client

redisVersion

  • get redisVersion(): string

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

    Returns string

Methods

close

  • close(): Promise<void>

  • Returns Promise<void>

    Closes the connection and returns a promise that resolves when the connection is closed.

count

  • count(): Promise<number>

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

    Returns Promise<number>

disconnect

emit

  • emit(event, ...args): boolean

  • Emits an event. Normally used by subclasses to emit events.

    Parameters

    • event: string | symbol

      The emitted event.

    • Rest ...args: any[]

    Returns boolean

getActive

  • getActive(start?, end?): Promise<Job<DataType, ResultType, NameType>[]>

  • 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<Job<DataType, ResultType, NameType>[]>

getActiveCount

  • getActiveCount(): Promise<number>

  • Returns the number of jobs in active status.

    Returns Promise<number>

getCompleted

  • getCompleted(start?, end?): Promise<Job<DataType, ResultType, NameType>[]>

  • 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<Job<DataType, ResultType, NameType>[]>

getCompletedCount

  • getCompletedCount(): Promise<number>

  • Returns the number of jobs in completed status.

    Returns Promise<number>

getDelayed

  • getDelayed(start?, end?): Promise<Job<DataType, ResultType, NameType>[]>

  • 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<Job<DataType, ResultType, NameType>[]>

getDelayedCount

  • getDelayedCount(): Promise<number>

  • Returns the number of jobs in delayed status.

    Returns Promise<number>

getFailed

  • getFailed(start?, end?): Promise<Job<DataType, ResultType, NameType>[]>

  • 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<Job<DataType, ResultType, NameType>[]>

getFailedCount

  • getFailedCount(): Promise<number>

  • Returns the number of jobs in failed status.

    Returns Promise<number>

getJob

  • getJob(jobId): Promise<Job<DataType, ResultType, NameType>>

  • Parameters

    • jobId: string

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

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

  • getJobState(jobId): Promise<"unknown" | JobState>

  • Get current job state.

    Parameters

    • jobId: string

    Returns Promise<"unknown" | JobState>

    Returns one of these values: 'completed', 'failed', 'delayed', 'active', 'waiting', 'waiting-children', 'unknown'.

getJobs

  • getJobs(types?, start?, end?, asc?): Promise<Job<DataType, ResultType, NameType>[]>

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

    Parameters

    • Optional types: 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<Job<DataType, ResultType, NameType>[]>

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: "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.

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.

getRanges

  • getRanges(types, start?, end?, asc?): Promise<string[]>

  • Parameters

    • types: JobType[]
    • start: number = 0
    • end: number = 1
    • asc: boolean = false

    Returns Promise<string[]>

getWaiting

  • getWaiting(start?, end?): Promise<Job<DataType, ResultType, NameType>[]>

  • 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<Job<DataType, ResultType, NameType>[]>

getWaitingChildren

  • getWaitingChildren(start?, end?): Promise<Job<DataType, ResultType, NameType>[]>

  • 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<Job<DataType, ResultType, NameType>[]>

getWaitingChildrenCount

  • getWaitingChildrenCount(): Promise<number>

  • Returns the number of jobs in waiting-children status.

    Returns Promise<number>

getWaitingCount

  • getWaitingCount(): Promise<number>

  • Returns the number of jobs in waiting or paused statuses.

    Returns Promise<number>

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.

waitUntilReady

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc