Universal DevTools Kit SDK / @u-devtools/core / Transport
Abstract Class: Transport
Defined in: transport.ts:14
Abstract class for message transport. Provides common logic for RPC calls and event subscriptions.
Extended by
Constructors
Constructor
new Transport():
Transport
Returns
Transport
Properties
disposed
protecteddisposed:boolean=false
Defined in: transport.ts:20
eventListeners
protectedeventListeners:Map<string,Set<(data) =>void>>
Defined in: transport.ts:19
handlers
protectedhandlers:Map<string, {reject: (error) =>void;resolve: (value) =>void; }>
Defined in: transport.ts:15
timeout
protectedtimeout:number=5000
Defined in: transport.ts:21
Methods
call()
call<
T>(method,payload?):Promise<T>
Defined in: transport.ts:41
RPC method call
Type Parameters
| Type Parameter | Default type |
|---|---|
T | unknown |
Parameters
| Parameter | Type |
|---|---|
method | string |
payload? | unknown |
Returns
Promise<T>
dispose()
dispose():
void
Defined in: transport.ts:160
Clean up all handlers and subscriptions
Returns
void
handleMessage()
protectedhandleMessage(data):void
Defined in: transport.ts:115
Handle incoming messages (called by transport)
Parameters
| Parameter | Type |
|---|---|
data | unknown |
Returns
void
off()
off(
event,fn):void
Defined in: transport.ts:105
Unsubscribe from events
Parameters
| Parameter | Type |
|---|---|
event | string |
fn | (data) => void |
Returns
void
on()
on(
event,fn): () =>void
Defined in: transport.ts:77
Subscribe to events
Parameters
| Parameter | Type |
|---|---|
event | string |
fn | (data) => void |
Returns
():
void
Returns
void
sendMessage()
abstractprotectedsendMessage(type,data):void
Defined in: transport.ts:26
Send a message through the transport
Parameters
| Parameter | Type |
|---|---|
type | string |
data | unknown |
Returns
void
subscribe()
abstractprotectedsubscribe(type,handler): () =>void
Defined in: transport.ts:31
Subscribe to messages from the transport
Parameters
| Parameter | Type |
|---|---|
type | string |
handler | (data) => void |
Returns
():
void
Returns
void
unsubscribe()?
abstractprotectedoptionalunsubscribe(type,handler):void
Defined in: transport.ts:36
Unsubscribe from transport messages
Parameters
| Parameter | Type |
|---|---|
type | string |
handler | (data) => void |
Returns
void