Chartbreaker
    Preparing search index...

    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: ((this: AbstractWorker, ev: ErrorEvent) => any) | null;
        onmessage: ((this: Worker, ev: MessageEvent) => any) | null;
        onmessageerror: ((this: Worker, ev: MessageEvent) => any) | null;
        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: ((this: AbstractWorker, ev: ErrorEvent) => any) | null

    MDN Reference

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

    MDN Reference

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

    MDN Reference

    Methods

    • The dispatchEvent() method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order. The normal event processing rules (including the capturing and optional bubbling phase) also apply to events dispatched manually with dispatchEvent().

      MDN Reference

      Parameters

      • event: Event

      Returns boolean

    • The postMessage() method of the Worker interface sends a message to the worker. The first parameter is the data to send to the worker. The data may be any JavaScript object that can be handled by the structured clone algorithm.

      MDN Reference

      Parameters

      Returns void

    • Parameters

      Returns void

    • The removeEventListener() method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target. The event listener to be removed is identified using a combination of the event type, the event listener function itself, and various optional options that may affect the matching process; see Matching event listeners for removal.

      MDN Reference

      Type Parameters

      Parameters

      Returns void

    • The removeEventListener() method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target. The event listener to be removed is identified using a combination of the event type, the event listener function itself, and various optional options that may affect the matching process; see Matching event listeners for removal.

      MDN Reference

      Parameters

      Returns void

    • The terminate() method of the Worker interface immediately terminates the Worker. This does not offer the worker an opportunity to finish its operations; it is stopped at once.

      MDN Reference

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Methods