Class QueueScheduler

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>

• Close the scheduler.

  Returns Promise<void>

disconnect

• disconnect(): Promise<void>

• Force disconnects a connection.

  Returns Promise<void>

emit

• emit<U>(event, ...args): boolean

• Type Parameters

  • U extends keyof QueueSchedulerListener

  Parameters

  • event: U

  • Rest ...args: Parameters<QueueSchedulerListener[U]>

  Returns boolean

isRunning

• isRunning(): boolean

• isRunning

  Returns boolean

  true if the scheduler is running

off

• off<U>(eventName, listener): QueueScheduler

• Type Parameters

  • U extends keyof QueueSchedulerListener

  Parameters

  • eventName: U

  • listener: QueueSchedulerListener[U]

  Returns QueueScheduler

on

• on<U>(event, listener): QueueScheduler

• Type Parameters

  • U extends keyof QueueSchedulerListener

  Parameters

  • event: U

  • listener: QueueSchedulerListener[U]

  Returns QueueScheduler

once

• once<U>(event, listener): QueueScheduler

• Type Parameters

  • U extends keyof QueueSchedulerListener

  Parameters

  • event: U

  • listener: QueueSchedulerListener[U]

  Returns QueueScheduler

run

• run(): Promise<void>

• Run the scheduler.

  This method will run the scheduler in the background, and will not return until the scheduler is closed.

  If the QueueScheduler was instantiated with autorun: false, then it is not needed to manually call this method.

  Returns Promise<void>

waitUntilReady

• waitUntilReady(): Promise<RedisClient>

• Returns Promise<RedisClient>