Class Worker<DataType, ResultType, NameType>

closing

keys

Readonly name

toKey

client

• get client(): Promise<RedisClient>

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

  Returns Promise<RedisClient>

concurrency

• set concurrency(concurrency): void

• Parameters

  • concurrency: number

  Returns void

redisVersion

• get redisVersion(): string

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

  Returns string

repeat

• get repeat(): Promise<Repeat>

• Returns Promise<Repeat>

close

• close(force?): Promise<void>

• Closes the worker and related redis connections.

  This method waits for current jobs to finalize before returning.

  Parameters

  • Optional force: boolean

    Use force boolean parameter if you do not want to wait for current jobs to be processed.

  Returns Promise<void>

  Promise that resolves when the worker has been closed.

delay

• delay(): Promise<void>

• This function is exposed only for testing purposes.

  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 WorkerListener<DataType, ResultType, NameType>

  Parameters

  • event: U

  • Rest ...args: Parameters<WorkerListener<DataType, ResultType, NameType>[U]>

  Returns boolean

getNextJob

• getNextJob(token, __namedParameters?): Promise<Job<DataType, ResultType, NameType>>

• Returns a promise that resolves to the next job in queue.

  Parameters

  • token: string

    worker token to be assigned to retrieved job

  • Optional __namedParameters: GetNextJobOptions

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

  a Job or undefined if no job was available in the queue.

isPaused

• isPaused(): boolean

• Checks if worker is paused.

  Returns boolean

  true if worker is paused, false otherwise.

isRunning

• isRunning(): boolean

• Checks if worker is currently running.

  Returns boolean

  true if worker is running, false otherwise.

off

• off<U>(eventName, listener): Worker<DataType, ResultType, NameType>

• Type Parameters

  • U extends keyof WorkerListener<DataType, ResultType, NameType>

  Parameters

  • eventName: U

  • listener: WorkerListener<DataType, ResultType, NameType>[U]

  Returns Worker<DataType, ResultType, NameType>

on

• on<U>(event, listener): Worker<DataType, ResultType, NameType>

• Type Parameters

  • U extends keyof WorkerListener<DataType, ResultType, NameType>

  Parameters

  • event: U

  • listener: WorkerListener<DataType, ResultType, NameType>[U]

  Returns Worker<DataType, ResultType, NameType>

once

• once<U>(event, listener): Worker<DataType, ResultType, NameType>

• Type Parameters

  • U extends keyof WorkerListener<DataType, ResultType, NameType>

  Parameters

  • event: U

  • listener: WorkerListener<DataType, ResultType, NameType>[U]

  Returns Worker<DataType, ResultType, NameType>

pause

• pause(doNotWaitActive?): Promise<void>

• Pauses the processing of this queue only for this worker.

  Parameters

  • Optional doNotWaitActive: boolean

  Returns Promise<void>

processJob

• processJob(job, token, fetchNextCallback?): Promise<void | Job<DataType, ResultType, NameType>>

• Parameters

  • job: Job<DataType, ResultType, NameType>

  • token: string

  • Optional fetchNextCallback: (() => boolean)

    • • (): boolean

      • Returns boolean

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

resume

• resume(): void

• Resumes processing of this worker (if paused).

  Returns void

run

• run(): Promise<any[]>

• Returns Promise<any[]>

waitUntilReady

• waitUntilReady(): Promise<RedisClient>

• Waits until the worker is ready to start processing jobs. In general only useful when writing tests.

  Returns Promise<RedisClient>