lspeasy / core/src / SharedWorkerTransport
Class: SharedWorkerTransport
Defined in: packages/core/src/transport/shared-worker.ts:20
JSON-RPC transport for Shared Worker environments with per-client envelope routing.
Implements
Constructors
Constructor
new SharedWorkerTransport(options): SharedWorkerTransport;Defined in: packages/core/src/transport/shared-worker.ts:73
Parameters
| Parameter | Type |
|---|---|
options | SharedWorkerTransportOptions |
Returns
SharedWorkerTransport
Methods
close()
close(): Promise<void>;Defined in: packages/core/src/transport/shared-worker.ts:128
Close the transport connection and release resources.
Returns
Promise<void>
Implementation of
isConnected()
isConnected(): boolean;Defined in: packages/core/src/transport/shared-worker.ts:148
Returns true if the transport is currently connected and able to send messages.
Returns
boolean
Implementation of
onClose()
onClose(handler): Disposable;Defined in: packages/core/src/transport/shared-worker.ts:119
Subscribe to connection close.
Parameters
| Parameter | Type | Description |
|---|---|---|
handler | () => void | Callback invoked when the transport is closed. |
Returns
A Disposable that unsubscribes the handler when disposed.
Implementation of
onError()
onError(handler): Disposable;Defined in: packages/core/src/transport/shared-worker.ts:110
Subscribe to transport errors.
Parameters
| Parameter | Type | Description |
|---|---|---|
handler | (error) => void | Callback invoked when a transport-level error occurs. |
Returns
A Disposable that unsubscribes the handler when disposed.
Implementation of
onMessage()
onMessage(handler): Disposable;Defined in: packages/core/src/transport/shared-worker.ts:101
Subscribe to incoming messages.
Parameters
| Parameter | Type | Description |
|---|---|---|
handler | (message) => void | Callback invoked for each received message. |
Returns
A Disposable that unsubscribes the handler when disposed.
Implementation of
send()
send(message): Promise<void>;Defined in: packages/core/src/transport/shared-worker.ts:88
Send a message to the remote peer.
Parameters
| Parameter | Type | Description |
|---|---|---|
message | Message | The JSON-RPC message to send. |
Returns
Promise<void>
Throws
If the transport is not connected or an I/O error occurs.