lspeasy / core/src / DedicatedWorkerTransport
Class: DedicatedWorkerTransport
Defined in: packages/core/src/transport/dedicated-worker.ts:13
JSON-RPC transport backed by a Dedicated Worker instance.
Implements
Constructors
Constructor
new DedicatedWorkerTransport(options): DedicatedWorkerTransport;Defined in: packages/core/src/transport/dedicated-worker.ts:38
Parameters
| Parameter | Type |
|---|---|
options | DedicatedWorkerTransportOptions |
Returns
DedicatedWorkerTransport
Methods
close()
close(): Promise<void>;Defined in: packages/core/src/transport/dedicated-worker.ts:81
Close the transport connection and release resources.
Returns
Promise<void>
Implementation of
isConnected()
isConnected(): boolean;Defined in: packages/core/src/transport/dedicated-worker.ts:103
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/dedicated-worker.ts:72
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/dedicated-worker.ts:63
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/dedicated-worker.ts:54
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/dedicated-worker.ts:46
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.