Interface Worker

This Web Workers API interface represents a background task that can be easily created and can send messages back to its creator. Creating a worker is as simple as calling the Worker() constructor and specifying a script to be run in the worker thread.

Hierarchy

Properties

onerror onmessage onmessageerror

Methods

addEventListener dispatchEvent postMessage removeEventListener terminate

Properties

onerror

onerror: null | ((this: AbstractWorker, ev: ErrorEvent) => any)

onmessage

onmessage: null | ((this: Worker, ev: MessageEvent<any>) => any)

onmessageerror

onmessageerror: null | ((this: Worker, ev: MessageEvent<any>) => any)

Methods

addEventListener

dispatchEvent

  • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

    Parameters

    Returns boolean

postMessage

  • Clones message and transmits it to worker's global environment. transfer can be passed as a list of objects that are to be transferred rather than cloned.

    Parameters

    Returns void

  • Parameters

    Returns void

removeEventListener

terminate

  • Aborts worker's associated global environment.

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc