Base class for all classes that need to interact with queues. This class is normally not used directly, but extended by the other classes.




closing: Promise<void>
keys: KeysMap
name: string
opts: QueueBaseOptions
qualifiedName: string
toKey: ((type) => string)

Type declaration

    • (type): string
    • Parameters

      • type: string

      Returns string


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

    Returns Promise<RedisClient>

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

    Returns string


  • Type Parameters

    • T = any

    • R = any

    • N extends string = string


    • name: N
    • data: T
    • opts: JobsOptions
    • Optional skipCheckExists: boolean

    Returns Promise<Job<T, R, N>>

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

    Returns Promise<void>

  • Force disconnects a connection.

    Returns Promise<void>

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


    • event: string | symbol

      The emitted event.

    • Rest ...args: any[]

    Returns boolean

  • Returns Promise<number>

  • Parameters

    • Optional start: number
    • Optional end: number
    • Optional asc: boolean

    Returns Promise<RepeatableJob[]>

  • Parameters

    • name: string
    • repeat: RepeatOptions
    • Optional jobId: string

    Returns Promise<number>

  • Parameters

    • repeatJobKey: string

    Returns Promise<number>

Generated using TypeDoc