Class WorkerPro<DataType, ResultType, NameType>

constructor

• new WorkerPro<DataType, ResultType, NameType>(name, processor?, opts?): WorkerPro<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 WorkerPro<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

getNextJob

• getNextJob(token, __namedParameters?): Promise<JobPro<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

  • __namedParameters: GetNextJobOptions = {}

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

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

off

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

• Type Parameters

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

  Parameters

  • eventName: U

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

  Returns WorkerPro<DataType, ResultType, NameType>

on

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

• Type Parameters

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

  Parameters

  • event: U

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

  Returns WorkerPro<DataType, ResultType, NameType>

once

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

• Type Parameters

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

  Parameters

  • event: U

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

  Returns WorkerPro<DataType, ResultType, NameType>

rateLimitGroup

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

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

  Parameters

  • job: JobPro<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>