Class QueueBase

constructor

• new QueueBase(name, opts?, Connection?): QueueBase

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

closing

keys

Readonly name

opts

toKey

client

• get client(): Promise<RedisClient>

• Returns a promise that resolves to a redis client. Normally used only by subclasses.

  Returns Promise<RedisClient>

redisVersion

• get redisVersion(): string

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

  Returns string

close

• close(): Promise<void>

• Returns Promise<void>

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

disconnect

• disconnect(): Promise<void>

• Force disconnects a connection.

  Returns Promise<void>

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

waitUntilReady

• waitUntilReady(): Promise<RedisClient>

• Returns Promise<RedisClient>