Universal DevTools Kit SDK

---

Universal DevTools Kit SDK / @u-devtools/core / HmrTransport

Class: HmrTransport

Defined in: transports/hmr-transport.ts:7

Transport based on Vite HMR (Hot Module Replacement) Used for communication between client (iframe) and server (Node.js)

Extends

• Transport

Constructors

Constructor

new HmrTransport(hot): HmrTransport

Defined in: transports/hmr-transport.ts:11

Parameters

Parameter	Type
hot	{ off?: (event, handler) => void; on: (event, handler) => void; send: (event, data) => void; }
hot.off?	(event, handler) => void
hot.on	(event, handler) => void
hot.send	(event, data) => void

Returns

HmrTransport

Overrides

Transport.constructor

Properties

disposed

protected disposed: boolean = false

Defined in: transport.ts:20

Inherited from

BroadcastTransport.disposed

---

eventListeners

protected eventListeners: Map<string, Set<(data) => void>>

Defined in: transport.ts:19

Inherited from

Transport.eventListeners

---

handlers

protected handlers: Map<string, { reject: (error) => void; resolve: (value) => void; }>

Defined in: transport.ts:15

Inherited from

Transport.handlers

---

timeout

protected timeout: number = 5000

Defined in: transport.ts:21

Inherited from

BroadcastTransport.timeout

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>

Inherited from

Transport.call

---

dispose()

dispose(): void

Defined in: transports/hmr-transport.ts:71

Clean up all handlers and subscriptions

Returns

void

Overrides

Transport.dispose

---

handleMessage()

protected handleMessage(data): void

Defined in: transport.ts:115

Handle incoming messages (called by transport)

Parameters

Parameter	Type
data	unknown

Returns

void

Inherited from

Transport.handleMessage

---

off()

off(event, fn): void

Defined in: transport.ts:105

Unsubscribe from events

Parameters

Parameter	Type
event	string
fn	(data) => void

Returns

void

Inherited from

Transport.off

---

on()

on(event, fn): () => void

Defined in: transports/hmr-transport.ts:37

Override on() for HMR, as subscription is already set up in constructor

Parameters

Parameter	Type
event	string
fn	(data) => void

Returns

(): void

Returns

void

Overrides

Transport.on

---

sendMessage()

protected sendMessage(type, data): void

Defined in: transports/hmr-transport.ts:52

Send a message through the transport

Parameters

Parameter	Type
type	string
data	unknown

Returns

void

Overrides

Transport.sendMessage

---

subscribe()

protected subscribe(_type, _handler): () => void

Defined in: transports/hmr-transport.ts:58

Subscribe to messages from the transport

Parameters

Parameter	Type
_type	string
_handler	(data) => void

Returns

(): void

Returns

void

Overrides

Transport.subscribe

---

unsubscribe()

protected unsubscribe(_type, _handler): void

Defined in: transports/hmr-transport.ts:66

Unsubscribe from transport messages

Parameters

Parameter	Type
_type	string
_handler	(data) => void

Returns

void

Overrides

Transport.unsubscribe