Skip to content
1 min read · 292 words

Interface: BrowserWorker

Defined in: src/batteries/isolation/browser.ts:60

Minimal subset of the DOM Worker interface this module touches. Structurally compatible with the real DOM Worker — callers (and WorkerResolver implementations) pass/construct real Worker instances directly.

Methods

addEventListener()

Call Signature

ts
addEventListener(type: "message", listener: (ev: BrowserMessageEvent) => void): void;

Defined in: src/batteries/isolation/browser.ts:64

Subscribe to the worker's 'message' event (fired on every postMessage received from the guest).

Parameters
ParameterType
type"message"
listener(ev: BrowserMessageEvent) => void
Returns

void

Call Signature

ts
addEventListener(type: "error", listener: (ev: BrowserErrorEvent) => void): void;

Defined in: src/batteries/isolation/browser.ts:67

Subscribe to the worker's 'error' event (fired when an uncaught error escapes the guest's top-level scope).

Parameters
ParameterType
type"error"
listener(ev: BrowserErrorEvent) => void
Returns

void

Call Signature

ts
addEventListener(type: "messageerror", listener: (ev: BrowserMessageEvent) => void): void;

Defined in: src/batteries/isolation/browser.ts:70

Subscribe to the worker's 'messageerror' event (fired when a received message could not be deserialized).

Parameters
ParameterType
type"messageerror"
listener(ev: BrowserMessageEvent) => void
Returns

void


postMessage()

ts
postMessage(message: unknown, transfer?: unknown[]): void;

Defined in: src/batteries/isolation/browser.ts:62

Post a message to the worker, optionally transferring ownership of listed transferables.

Parameters

ParameterType
messageunknown
transfer?unknown[]

Returns

void


removeEventListener()

ts
removeEventListener(type: "error" | "message" | "messageerror", listener: (ev: never) => void): void;

Defined in: src/batteries/isolation/browser.ts:72

Unsubscribe a previously-added listener.

Parameters

ParameterType
type"error" | "message" | "messageerror"
listener(ev: never) => void

Returns

void


terminate()

ts
terminate(): void;

Defined in: src/batteries/isolation/browser.ts:77

Terminate the worker immediately — no further events, no graceful shutdown at this layer.

Returns

void