Class WorkerSelf

Wrapper for the WorkerGlobalScope in the browser/deno and MessagePort in NodeJS.

This class is not meant to be used directly, instead, the WorkerSelf module exports a single instance of this class.

Hierarchy

WorkerSelf

Index

Accessors

ready
self

Methods

Accessors

ready

get ready(): Promise<void>

- Defined in src/WorkerSelf.ts:27
Returns a promise that, when resolved, indicates when the WorkerSelfWrapper is ready to be used.

Returns Promise<void>

self

get self(): WorkerGlobalScope | MessagePort

- Defined in src/WorkerSelf.ts:41
Returns the underlying WorkerGlobalScope or MessagePort for the platform.

Returns WorkerGlobalScope | MessagePort

Methods

addEventListener

addEventListener(event: string, listener: (...args: any[]) => void): void

- Defined in src/WorkerSelf.ts:89
Minimum viable API to provide the browser's addEventListener API for all platforms.

Parameters
- event: string
  
  The event to subscribe to.
- listener: (...args: any[]) => void
  
  Event handler function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns void

Private initialize

initialize(): Promise<void>

- Defined in src/WorkerSelf.ts:48
Initializes the underlying messaging system for the platform.

Returns Promise<void>

off

off(event: string, listener: (...args: any[]) => void): void

- Defined in src/WorkerSelf.ts:76
Minimum viable API to provide node's off API for all platforms.

Parameters
- event: string
  
  The event to unsubscribe from
- listener: (...args: any[]) => void
  
  Event handler function that was registered using either on or addEventListener
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns void

on

on(event: string, listener: (...args: any[]) => void): void

- Defined in src/WorkerSelf.ts:63
Minimum viable API to provide node's on API for all platforms.

Parameters
- event: string
  
  The event to subscribe to.
- listener: (...args: any[]) => void
  
  Event handler function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns void

postMessage

postMessage(message: any, transferList?: ArrayBuffer[]): void

- Defined in src/WorkerSelf.ts:116
Posts a message to the code owner of this worker thread, this is meant to be homogeneous across platforms.

Parameters
- message: any
  
  The message to send to the worker, can be anything that is supported by the structured clone algorithm
- Optional transferList: ArrayBuffer[]
  
  Objects to transfer to the worker, limited to ArrayBuffer objects as a minimum viable API on all platforms.
Returns void

removeEventListener

removeEventListener(event: string, listener: (...args: any[]) => void): void

- Defined in src/WorkerSelf.ts:102
Minimum viable API to provide the browser's removeEventListener API for all platforms.

Parameters
- event: string
  
  The event to unsubscribe from
- listener: (...args: any[]) => void
  
  Event handler function that was registered using either on or addEventListener
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns void

Generated using TypeDoc