Class Worker<DataType, ResultType, NameType>

Type Parameters

DataType = any
ResultType = any
NameType extends string = string

Hierarchy

Worker<DataType, ResultType, NameType>
- Worker

Index

Constructors

Properties

opts RateLimitError

Methods

Constructors

constructor

new Worker<DataType, ResultType, NameType>(name: string, processor?: string | ProcessorPro<DataType, ResultType, NameType>, opts?: WorkerProOptions): Worker<DataType, ResultType, NameType>
Type Parameters
- DataType = any
- ResultType = any
- NameType extends string = string
Parameters
- name: string
- Optional processor: string | ProcessorPro<DataType, ResultType, NameType>
- Optional opts: WorkerProOptions
Returns Worker<DataType, ResultType, NameType>
Overrides Worker<DataType, ResultType, NameType>.constructor
- Defined in src/classes/worker-pro.ts:24

Properties

opts

opts: WorkerProOptions

`Static` RateLimitError

RateLimitError: (() => Error) = Worker.RateLimitError

Type declaration

- (): Error
- Returns Error

Methods

rateLimitGroup

rateLimitGroup(job: Job<any, any, string>, expireTimeMs: number): 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>
- Defined in src/classes/worker-pro.ts:134

Generated using TypeDoc