Class SharedWorker

constructor

• new SharedWorker(url, opts?): SharedWorker

• Parameters

  • url: string | URL
  • Optional opts: WorkerOptions & {
        useWebWorker?: boolean;
    }

  Returns SharedWorker

ActualWorker

isSharedWorkerSupported

• get isSharedWorkerSupported(): boolean

• Returns boolean

onerror

• get onerror(): ((this, ev) => unknown)

• Is an EventListener that is called whenever an ErrorEvent of type error event occurs.

  Returns ((this, ev) => unknown)

  • • (this, ev): unknown

    • Parameters

      • this: AbstractWorker
      • ev: ErrorEvent

      Returns unknown
• set onerror(value): void

• Parameters

  • value: ((this, ev) => unknown)
    • • (this, ev): unknown

      • Parameters

        • this: AbstractWorker
        • ev: ErrorEvent

        Returns unknown

  Returns void

onmessage

• get onmessage(): ((this, ev) => any) | ((this, ev) => any)

• An EventListener called when MessageEvent of type message is fired on the port—that is, when the port receives a message.

  Returns ((this, ev) => any) | ((this, ev) => any)
• set onmessage(value): void

• Parameters

  • value: ((this, ev) => any) | ((this, ev) => any)

  Returns void

onmessageerror

• get onmessageerror(): ((this, ev) => any) | ((this, ev) => any)

• An EventListener called when a MessageEvent of type MessageError is fired—that is, when it receives a message that cannot be deserialized.

  Returns ((this, ev) => any) | ((this, ev) => any)
• set onmessageerror(value): void

• Parameters

  • value: ((this, ev) => any) | ((this, ev) => any)

  Returns void

port

• get port(): MessagePort

• Returns a MessagePort object used to communicate with and control the shared worker.

  Returns MessagePort

addEventListener

• addEventListener<K>(type, listener, options?): void

• Registers an event handler of a specific event type on the EventTarget

  Type Parameters

  • K extends keyof WorkerEventMap

  Parameters

  • type: K
  • listener: ((this, ev) => unknown)
    • • (this, ev): unknown

      • Parameters

        • this: Worker
        • ev: WorkerEventMap[K]

        Returns unknown

  • Optional options: boolean | AddEventListenerOptions

  Returns void
• addEventListener(type, listener, options?): void

• Parameters

  • type: string
  • listener: EventListenerOrEventListenerObject
  • Optional options: boolean | AddEventListenerOptions

  Returns void

• addEventListener<K>(type, listener, options?): void

• Type Parameters

  • K extends keyof MessagePortEventMap

  Parameters

  • type: K
  • listener: ((this, ev) => unknown)
    • • (this, ev): unknown

      • Parameters

        • this: MessagePort
        • ev: MessagePortEventMap[K]

        Returns unknown

  • Optional options: boolean | AddEventListenerOptions

  Returns void

close

• close(): void

• Disconnects the port, so it is no longer active.

  Returns void

dispatchEvent

• dispatchEvent(event): boolean

• Dispatches an event to this EventTarget.

  Parameters

  • event: Event

  Returns boolean

postMessage

• postMessage(message, transfer?): void

• 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

  • message: any
  • Optional transfer: Transferable[] | StructuredSerializeOptions

  Returns void

removeEventListener

• removeEventListener<K>(type, listener, options?): void

• Removes an event listener from the EventTarget.

  Type Parameters

  • K extends keyof WorkerEventMap

  Parameters

  • type: K
  • listener: ((this, ev) => unknown)
    • • (this, ev): unknown

      • Parameters

        • this: Worker
        • ev: WorkerEventMap[K]

        Returns unknown

  • Optional options: boolean | EventListenerOptions

  Returns void
• removeEventListener(type, listener, options?): void

• Parameters

  • type: string
  • listener: EventListenerOrEventListenerObject
  • Optional options: boolean | EventListenerOptions

  Returns void

• removeEventListener<K>(type, listener, options?): void

• Type Parameters

  • K extends keyof MessagePortEventMap

  Parameters

  • type: K
  • listener: ((this, ev) => unknown)
    • • (this, ev): unknown

      • Parameters

        • this: MessagePort
        • ev: MessagePortEventMap[K]

        Returns unknown

  • Optional options: boolean | EventListenerOptions

  Returns void

start

• start(): void

• Starts the sending of messages queued on the port (only needed when using EventTarget.addEventListener; it is implied when using MessagePort.onmessage.)

  Returns void

terminate

• terminate(): void

• Immediately terminates the worker. This does not let worker finish its operations; it is halted at once. ServiceWorker instances do not support this method.

  Returns void