Class Worker<DataType, ResultType, NameType>

constructor

• new Worker<DataType, ResultType, NameType>(name, processor?, opts?): Worker<DataType, ResultType, NameType>

• Type Parameters

  • DataType = any

  • ResultType = any

  • NameType extends string = string

  Parameters

  • name: string

  • Optional processor: string | URL | ProcessorPro<DataType, ResultType, NameType>

  • Optional opts: WorkerProOptions

  Returns Worker<DataType, ResultType, NameType>

opts

Static RateLimitError

emit

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

• Type Parameters

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

  Parameters

  • event: U

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

  Returns boolean

off

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

• Type Parameters

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

  Parameters

  • eventName: U

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

  Returns Worker<DataType, ResultType, NameType>

on

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

• Type Parameters

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

  Parameters

  • event: U

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

  Returns Worker<DataType, ResultType, NameType>

once

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

• Type Parameters

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

  Parameters

  • event: U

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

  Returns Worker<DataType, ResultType, NameType>

rateLimitGroup

• rateLimitGroup(job, expireTimeMs): Promise<void>

• Overrides the rate limit so that it becomes active for the given group.

  Parameters

  • job: Job<any, any, string>

    Job currently being processed, and whose group we want to rate limit.

  • expireTimeMs: number

    Expire time in ms of this rate limit.

  Returns Promise<void>