Class QueueGetters<DataType, ResultType, NameType>

Description

Provides different getters for different aspects of a queue.

Type Parameters

  • DataType

  • ResultType

  • NameType extends string

Hierarchy

Constructors

  • 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: Promise<void>
keys: KeysMap
name: string

The name of the queue.

opts: QueueBaseOptions = {}

Options for the queue.

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

Type declaration

    • (type: string): string
    • Parameters

      • type: string

      Returns string

Accessors

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

    Returns string

Methods

  • Returns

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

    Returns Promise<void>

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

    Returns Promise<number>

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

    Returns

    Parameters

    • event: string | symbol

      The emitted event.

    • Rest ...args: any[]

    Returns boolean

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

  • Returns the number of jobs in active status.

    Returns Promise<number>

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

  • Returns the number of jobs in completed status.

    Returns Promise<number>

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

  • Returns the number of jobs in delayed status.

    Returns Promise<number>

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

  • Returns the number of jobs in failed status.

    Returns Promise<number>

  • Parameters

    • jobId: string

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

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

    Returns

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

    Parameters

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

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

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

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

    Returns

    • Returns an object with queue metrics.

    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>

  • Get queue events list related to the queue.

    Returns

    • Returns an array with queue events info.

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

  • Get queue schedulers list related to the queue.

    Returns

    • Returns an array with queue schedulers info.

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

  • Parameters

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

    Returns Promise<string[]>

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

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

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

    Returns Promise<number>

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

    Returns Promise<number>

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

    Returns

    • Returns an array with workers info.

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

Generated using TypeDoc