Interface Worker

The Worker interface of the Web Workers API represents a background task that can be created via script, which can send messages back to its creator.

MDN Reference

interface Worker {
    onerror: null | ((this: AbstractWorker, ev: ErrorEvent) => any);
    onmessage: null | ((this: Worker, ev: MessageEvent) => any);
    onmessageerror: null | ((this: Worker, ev: MessageEvent) => any);
    addEventListener<K extends keyof WorkerEventMap>(
        type: K,
        listener: (this: Worker, ev: WorkerEventMap[K]) => any,
        options?: boolean | AddEventListenerOptions,
    ): void;
    addEventListener(
        type: string,
        listener: EventListenerOrEventListenerObject,
        options?: boolean | AddEventListenerOptions,
    ): void;
    dispatchEvent(event: Event): boolean;
    postMessage(message: any, transfer: Transferable[]): void;
    postMessage(message: any, options?: StructuredSerializeOptions): void;
    removeEventListener<K extends keyof WorkerEventMap>(
        type: K,
        listener: (this: Worker, ev: WorkerEventMap[K]) => any,
        options?: boolean | EventListenerOptions,
    ): void;
    removeEventListener(
        type: string,
        listener: EventListenerOrEventListenerObject,
        options?: boolean | EventListenerOptions,
    ): void;
    terminate(): void;
}

Hierarchy (View Summary)

Index

Properties

onerror onmessage onmessageerror

Methods

addEventListener dispatchEvent postMessage removeEventListener terminate

Properties

onerror

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

MDN Reference

onmessage

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

MDN Reference

onmessageerror

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

MDN Reference

Methods

addEventListener

addEventListener<K extends keyof WorkerEventMap>(
    type: K,
    listener: (this: Worker, ev: WorkerEventMap[K]) => any,
    options?: boolean | AddEventListenerOptions,
): void
The addEventListener() method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.

MDN Reference
Type Parameters
- K extends keyof WorkerEventMap
Parameters
- type: K
- listener: (this: Worker, ev: WorkerEventMap[K]) => any
- Optionaloptions: boolean | AddEventListenerOptions
Returns void
Overrides AbstractWorker.addEventListener
addEventListener(
    type: string,
    listener: EventListenerOrEventListenerObject,
    options?: boolean | AddEventListenerOptions,
): void
The addEventListener() method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.

MDN Reference
Parameters
- type: string
- listener: EventListenerOrEventListenerObject
- Optionaloptions: boolean | AddEventListenerOptions
Returns void
Overrides AbstractWorker.addEventListener

dispatchEvent

dispatchEvent(event: Event): boolean
The dispatchEvent() method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.

MDN Reference
Parameters
- event: Event
Returns boolean
Inherited from EventTarget.dispatchEvent

postMessage

postMessage(message: any, transfer: Transferable[]): void
The postMessage() method of the Worker interface sends a message to the worker.

MDN Reference
Parameters
- message: any
- transfer: Transferable[]
Returns void
postMessage(message: any, options?: StructuredSerializeOptions): void
Parameters
- message: any
- Optionaloptions: StructuredSerializeOptions
Returns void

removeEventListener

removeEventListener<K extends keyof WorkerEventMap>(
    type: K,
    listener: (this: Worker, ev: WorkerEventMap[K]) => any,
    options?: boolean | EventListenerOptions,
): void
The removeEventListener() method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.

MDN Reference
Type Parameters
- K extends keyof WorkerEventMap
Parameters
- type: K
- listener: (this: Worker, ev: WorkerEventMap[K]) => any
- Optionaloptions: boolean | EventListenerOptions
Returns void
Overrides AbstractWorker.removeEventListener
removeEventListener(
    type: string,
    listener: EventListenerOrEventListenerObject,
    options?: boolean | EventListenerOptions,
): void
The removeEventListener() method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.

MDN Reference
Parameters
- type: string
- listener: EventListenerOrEventListenerObject
- Optionaloptions: boolean | EventListenerOptions
Returns void
Overrides AbstractWorker.removeEventListener

terminate

terminate(): void
The terminate() method of the Worker interface immediately terminates the Worker.

MDN Reference

Returns void

Interface Worker

Hierarchy (View Summary)

Index

Properties

Methods

Properties

onerror

onmessage

onmessageerror

Methods

addEventListener

Type Parameters

Parameters

Returns void

Parameters

Returns void

dispatchEvent

Parameters

Returns boolean

postMessage

Parameters

Returns void

Parameters

Returns void

removeEventListener

Type Parameters

Parameters

Returns void

Parameters

Returns void

terminate

Returns void

Settings

On This Page