Class Worker

Worker script with its own JavaScript heap, lock, etc.

This is useful to move heavy processing to a background thread, allowing hooks to be handled in a timely manner.

Index

Constructors

Properties

Methods

Constructors

constructor

new Worker(url: string, options?: WorkerOptions): Worker
Creates a worker script.
Parameters
- url: string
  URL of the worker's entrypoint module. Typically retrieved by having the module export its import.meta.url, and importing that from the module that creates the worker.
- Optionaloptions: WorkerOptions
  Options to customize the worker.
Returns Worker

Properties

exports

exports: WorkerExports

Magic proxy object for calling rpc.exports defined by the worker.

Methods

post

post(message: any, data?: ArrayBuffer | number[]): void
Posts a message to the worker.

Use recv() to receive it inside the worker.
Parameters
- message: any
- Optionaldata: ArrayBuffer | number[]
Returns void

terminate

terminate(): void
Terminates the worker.

Returns void