From 1c891dca43483d9ac4d5ed2538a01806f46148d9 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Fri, 15 Oct 2021 17:24:52 +0000 Subject: [PATCH] chore(gh-bot): :rocket: build types, api & library files --- docs/classes/SharedWorkerPolyfill.html | 30 +++++++++++++------------- docs/modules.html | 2 +- 2 files changed, 16 insertions(+), 16 deletions(-) diff --git a/docs/classes/SharedWorkerPolyfill.html b/docs/classes/SharedWorkerPolyfill.html index 6cc115d..a703173 100644 --- a/docs/classes/SharedWorkerPolyfill.html +++ b/docs/classes/SharedWorkerPolyfill.html @@ -1,33 +1,33 @@ SharedWorkerPolyfill | @okikio/sharedworker - v0.0.0-development
Options
All
  • Public
  • Public/Protected
  • All
Menu

A polyfill class for SharedWorker, it accepts a URL/string as well as any other options the spec. allows for SharedWorker. It supports all the same methods and properties as the original, except it adds compatibility methods and properties for older browsers that don't support SharedWorker, so, it can switch to normal Workers instead.

-

Hierarchy

  • SharedWorkerPolyfill

Implements

  • SharedWorker

Index

Constructors

constructor

Properties

ActualWorker

ActualWorker: SharedWorker | Worker
+

Hierarchy

  • SharedWorkerPolyfill

Implements

  • SharedWorker

Index

Constructors

constructor

Properties

ActualWorker

ActualWorker: SharedWorker | Worker

The actual worker that is used, depending on browser support it can be either a SharedWorker or a normal Worker.

-

Accessors

onerror

  • get onerror(): (ev: ErrorEvent) => any
  • set onerror(value: (ev: ErrorEvent) => any): void

Accessors

onerror

  • get onerror(): (ev: ErrorEvent) => any
  • set onerror(value: (ev: ErrorEvent) => any): void
  • Is an EventListener that is called whenever an ErrorEvent of type error event occurs.

    -

    Returns (ev: ErrorEvent) => any

      • (ev: ErrorEvent): any
      • Parameters

        • ev: ErrorEvent

        Returns any

  • +

    Returns (ev: ErrorEvent) => any

      • (ev: ErrorEvent): any
      • Parameters

        • ev: ErrorEvent

        Returns any

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

    -

    Parameters

    • value: (ev: ErrorEvent) => any
        • (ev: ErrorEvent): any
        • Parameters

          • ev: ErrorEvent

          Returns any

    Returns void

onmessage

  • get onmessage(): ((ev: MessageEvent<any>) => any) | ((ev: MessageEvent<any>) => any)
  • set onmessage(value: ((ev: MessageEvent<any>) => any) | ((ev: MessageEvent<any>) => any)): void
  • +

    Parameters

    • value: (ev: ErrorEvent) => any
        • (ev: ErrorEvent): any
        • Parameters

          • ev: ErrorEvent

          Returns any

    Returns void

onmessage

  • get onmessage(): ((ev: MessageEvent<any>) => any) | ((ev: MessageEvent<any>) => any)
  • set onmessage(value: ((ev: MessageEvent<any>) => any) | ((ev: MessageEvent<any>) => any)): void
  • An EventListener called when MessageEvent of type message is fired on the port—that is, when the port receives a message.

    -

    Returns ((ev: MessageEvent<any>) => any) | ((ev: MessageEvent<any>) => any)

  • +

    Returns ((ev: MessageEvent<any>) => any) | ((ev: MessageEvent<any>) => any)

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

    -

    Parameters

    • value: ((ev: MessageEvent<any>) => any) | ((ev: MessageEvent<any>) => any)

    Returns void

onmessageerror

  • get onmessageerror(): ((ev: MessageEvent<any>) => any) | ((ev: MessageEvent<any>) => any)
  • set onmessageerror(value: ((ev: MessageEvent<any>) => any) | ((ev: MessageEvent<any>) => any)): void
  • +

    Parameters

    • value: ((ev: MessageEvent<any>) => any) | ((ev: MessageEvent<any>) => any)

    Returns void

onmessageerror

  • get onmessageerror(): ((ev: MessageEvent<any>) => any) | ((ev: MessageEvent<any>) => any)
  • set onmessageerror(value: ((ev: MessageEvent<any>) => any) | ((ev: MessageEvent<any>) => any)): void
  • An EventListener called when a MessageEvent of type MessageError is fired—that is, when it receives a message that cannot be deserialized.

    -

    Returns ((ev: MessageEvent<any>) => any) | ((ev: MessageEvent<any>) => any)

  • +

    Returns ((ev: MessageEvent<any>) => any) | ((ev: MessageEvent<any>) => any)

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

    -

    Parameters

    • value: ((ev: MessageEvent<any>) => any) | ((ev: MessageEvent<any>) => any)

    Returns void

port

  • get port(): MessagePort
  • +

    Parameters

    • value: ((ev: MessageEvent<any>) => any) | ((ev: MessageEvent<any>) => any)

    Returns void

port

  • get port(): MessagePort
  • Returns a MessagePort object used to communicate with and control the shared worker.

    -

    Returns MessagePort

Methods

addEventListener

  • addEventListener<K>(type: K, listener: (ev: AbstractWorkerEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void
  • +

    Returns MessagePort

Methods

addEventListener

  • addEventListener<K>(type: K, listener: (ev: AbstractWorkerEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void
  • Registers an event handler of a specific event type on the EventTarget

    -

    Type parameters

    • K: "error"

    Parameters

    • type: K
    • listener: (ev: AbstractWorkerEventMap[K]) => any
        • (ev: AbstractWorkerEventMap[K]): any
        • Parameters

          • ev: AbstractWorkerEventMap[K]

          Returns any

    • Optional options: boolean | AddEventListenerOptions

    Returns void

close

  • close(): void
  • +

    Type parameters

    • K: "error"

    Parameters

    • type: K
    • listener: (ev: AbstractWorkerEventMap[K]) => any
        • (ev: AbstractWorkerEventMap[K]): any
        • Parameters

          • ev: AbstractWorkerEventMap[K]

          Returns any

    • Optional options: boolean | AddEventListenerOptions

    Returns void

close

  • close(): void
  • Disconnects the port, so it is no longer active.

    -

    Returns void

dispatchEvent

  • dispatchEvent(event: Event): boolean
  • +

    Returns void

dispatchEvent

  • dispatchEvent(event: Event): boolean
  • Dispatches an event to this EventTarget.

    -

    Parameters

    • event: Event

    Returns boolean

postMessage

  • postMessage(message: any, transfer?: Transferable[]): void

postMessage

  • postMessage(message: any, transfer?: Transferable[]): 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[]

    Returns void

removeEventListener

  • removeEventListener<K>(type: K, listener: (ev: WorkerEventMap[K]) => any, options?: boolean | EventListenerOptions): void
  • +

    Parameters

    • message: any
    • Optional transfer: Transferable[]

    Returns void

removeEventListener

  • removeEventListener<K>(type: K, listener: (ev: WorkerEventMap[K]) => any, options?: boolean | EventListenerOptions): void
  • Removes an event listener from the EventTarget.

    -

    Type parameters

    • K: "error"

    Parameters

    • type: K
    • listener: (ev: WorkerEventMap[K]) => any
        • (ev: WorkerEventMap[K]): any
        • Parameters

          • ev: WorkerEventMap[K]

          Returns any

    • Optional options: boolean | EventListenerOptions

    Returns void

start

  • start(): void
  • +

    Type parameters

    • K: "error"

    Parameters

    • type: K
    • listener: (ev: WorkerEventMap[K]) => any
        • (ev: WorkerEventMap[K]): any
        • Parameters

          • ev: WorkerEventMap[K]

          Returns any

    • 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

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

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/modules.html b/docs/modules.html index 74a4a1f..aa2cd1d 100644 --- a/docs/modules.html +++ b/docs/modules.html @@ -1,3 +1,3 @@ -@okikio/sharedworker - v0.0.0-development
Options
All
  • Public
  • Public/Protected
  • All
Menu

@okikio/sharedworker - v0.0.0-development

Index

References

default

Renames and re-exports SharedWorkerPolyfill

Variables

SharedWorkerSupported

SharedWorkerSupported: boolean = ...
+@okikio/sharedworker - v0.0.0-development
Options
All
  • Public
  • Public/Protected
  • All
Menu

@okikio/sharedworker - v0.0.0-development

Index

References

default

Renames and re-exports SharedWorkerPolyfill

Variables

SharedWorkerSupported

SharedWorkerSupported: boolean = ...

indicates if SharedWorker is supported, in the global scope

Legend

  • Constructor
  • Property
  • Method
  • Accessor

Settings

Theme

Generated using TypeDoc

\ No newline at end of file