Class WorkerPro<DataType, ResultType, NameType>

constructor

• new WorkerPro<
      DataType = any,
      ResultType = any,
      NameType extends string = string,
  >(
      name: string,
      processor?: string | URL | ProcessorPro<DataType, ResultType, NameType>,
      opts?: WorkerProOptions,
  ): WorkerPro<DataType, ResultType, NameType>

  Type Parameters

  • DataType = any
  • ResultType = any
  • NameType extends string = string

  Parameters

  • name: string
  • Optionalprocessor: string | URL | ProcessorPro<DataType, ResultType, NameType>
  • Optionalopts: WorkerProOptions

  Returns WorkerPro<DataType, ResultType, NameType>

opts

scripts

StaticRateLimitError

jobScheduler

• get jobScheduler(): Promise<JobSchedulerPro>

  Returns Promise<JobSchedulerPro>

repeat

• get repeat(): Promise<RepeatPro>

  Returns Promise<RepeatPro>

emit

• emit<U extends keyof WorkerProListener<DataType, ResultType, NameType>>(
      event: U,
      ...args: Parameters<WorkerProListener<DataType, ResultType, NameType>[U]>,
  ): boolean

  Type Parameters

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

  Parameters

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

  Returns boolean

getNextJob

• getNextJob(
      token: string,
      __namedParameters?: GetNextJobOptions,
  ): 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 extends keyof WorkerProListener<DataType, ResultType, NameType>>(
      eventName: U,
      listener: WorkerProListener<DataType, ResultType, NameType>[U],
  ): this

  Type Parameters

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

  Parameters

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

  Returns this

on

• on<U extends keyof WorkerProListener<DataType, ResultType, NameType>>(
      event: U,
      listener: WorkerProListener<DataType, ResultType, NameType>[U],
  ): this

  Type Parameters

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

  Parameters

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

  Returns this

once

• once<U extends keyof WorkerProListener<DataType, ResultType, NameType>>(
      event: U,
      listener: WorkerProListener<DataType, ResultType, NameType>[U],
  ): this

  Type Parameters

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

  Parameters

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

  Returns this

rateLimitGroup

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

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

  Parameters

  • job: JobPro

    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>