Class WorkerController<TInputMessage, TOutputMessage>

constructor

• new WorkerController<TInputMessage, TOutputMessage>(
      workerConstructor: WorkerConstructor,
      workerName: string,
      maxWorkers?: number,
  ): WorkerController<TInputMessage, TOutputMessage>

  Creates a new webworkers controller

  Type Parameters

  • TInputMessage
  • TOutputMessage

  Parameters

  • workerConstructor: WorkerConstructor

    Worker constructor

  • workerName: string

    Name of the worker

  • OptionalmaxWorkers: number

  Returns WorkerController<TInputMessage, TOutputMessage>

ignoreWorkerMessage

onerror

onmessage

onmessageerror

maxWorkers

• get maxWorkers(): number

  Maximum number of workers the controller can allocate

  Returns number

• set maxWorkers(value: number): void

  Parameters

  • value: number

  Returns void

areAllWorkersFree

• areAllWorkersFree(): boolean

  Returns whether all the worker are free

  Returns boolean

freeAllWorkers

• freeAllWorkers(): void

  Frees all the workers

  Returns void

freeWorker

• freeWorker(workerId: number): void

  Frees the given worker

  Parameters

  • workerId: number

  Returns void

hasFreeWorkers

• hasFreeWorkers(): boolean

  Returns whether the controller has free workers

  Returns boolean

lockWorker

• lockWorker(workerId: number): void

  Locks the given worker

  Parameters

  • workerId: number

  Returns void

nextFreeWorker

• nextFreeWorker(): number | null

  Returns the next workerId available in the stack

  Returns number | null

postMessage

• postMessage(message: TInputMessage, transfer?: Transferable[]): number

  Posts a message to the next available worker

  Parameters

  • message: TInputMessage

    Input message

  • transfer: Transferable[] = []

    Transferable objects

  Returns number

  The id of the worker that handled the message

postMessageWithId

• postMessageWithId(
      workerId: number,
      message: TInputMessage,
      transfer?: Transferable[],
  ): void

  Posts a message to a specific worker

  Parameters

  • workerId: number

    The id of the worker to use

  • message: TInputMessage

    Input message

  • transfer: Transferable[] = []

    Transferable objects

  Returns void

reset

• reset(): void

  Reset controller workers

  Returns void

stop

• stop(): void

  Stop jobs

  Returns void

terminateWorker

• terminateWorker(workerId: number): void

  Terminate a worker in the controller

  Parameters

  • workerId: number

  Returns void

terminateWorkers

• terminateWorkers(): void

  Terminates all the workers in the controller

  Returns void