Class Worker<DataType, ResultType, NameType>

Type Parameters

  • DataType = any

  • ResultType = any

  • NameType extends string = string

Hierarchy

  • Worker<DataType, ResultType, NameType>
    • Worker

Constructors

  • Type Parameters

    • DataType = any

    • ResultType = any

    • NameType extends string = string

    Parameters

    Returns Worker<DataType, ResultType, NameType>

Properties

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

Type declaration

    • (type): string
    • Parameters

      • type: string

      Returns string

Accessors

  • get client(): Promise<RedisClient>
  • Returns Promise<RedisClient>

  • get redisVersion(): string
  • Returns string

  • get repeat(): Promise<Repeat>
  • Returns Promise<Repeat>

Methods

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

  • This function is exposed only for testing purposes.

    Returns Promise<void>

  • Returns Promise<void>

  • Type Parameters

    Parameters

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

    Returns boolean

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

  • Checks if worker is paused.

    Returns boolean

    true if worker is paused, false otherwise.

  • Checks if worker is currently running.

    Returns boolean

    true if worker is running, false otherwise.

  • Type Parameters

    Parameters

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

    Returns Worker<DataType, ResultType, NameType>

  • Type Parameters

    Parameters

    Returns Worker<DataType, ResultType, NameType>

  • Type Parameters

    Parameters

    Returns Worker<DataType, ResultType, NameType>

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

    Parameters

    • Optional doNotWaitActive: boolean

    Returns Promise<void>

  • Parameters

    • job: Job<DataType, ResultType, NameType>
    • token: string

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

  • Resumes processing of this worker (if paused).

    Returns void

  • Returns Promise<any[]>

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

    Returns Promise<RedisClient>

Generated using TypeDoc