Universal DevTools Kit SDK

---

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

Class: BroadcastTransport

Defined in: transports/broadcast-transport.ts:8

Transport based on BroadcastChannel Used for communication between App (window) and Client (iframe) Does not support RPC (call), only events (send/on)

Extends

• Transport

Constructors

Constructor

new BroadcastTransport(namespace): BroadcastTransport

Defined in: transports/broadcast-transport.ts:13

Parameters

Parameter	Type
namespace	string

Returns

BroadcastTransport

Overrides

Transport.constructor

Properties

disposed

protected disposed: boolean = false

Defined in: transport.ts:20

Inherited from

Transport.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

Transport.timeout

Methods

call()

call<T>(_method, _payload?): Promise<T>

Defined in: transports/broadcast-transport.ts:127

RPC calls are not supported in BroadcastChannel

Type Parameters

Type Parameter	Default type
T	unknown

Parameters

Parameter	Type
_method	string
_payload?	unknown

Returns

Promise<T>

Overrides

Transport.call

---

close()

close(): void

Defined in: transports/broadcast-transport.ts:171

Close channel (alias for dispose)

Returns

void

---

dispose()

dispose(): void

Defined in: transports/broadcast-transport.ts:163

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: transport.ts:77

Subscribe to events

Parameters

Parameter	Type
event	string
fn	(data) => void

Returns

(): void

Returns

void

Inherited from

Transport.on

---

send()

send(event, data?): void

Defined in: transports/broadcast-transport.ts:75

Send event (not RPC)

Parameters

Parameter	Type
event	string
data?	unknown

Returns

void

---

sendMessage()

protected sendMessage(_type, _data): void

Defined in: transports/broadcast-transport.ts:133

Send a message through the transport

Parameters

Parameter	Type
_type	string
_data	unknown

Returns

void

Overrides

Transport.sendMessage

---

subscribe()

protected subscribe(event, handler): () => void

Defined in: transports/broadcast-transport.ts:138

Subscribe to messages from the transport

Parameters

Parameter	Type
event	string
handler	(data) => void

Returns

(): void

Returns

void

Overrides

Transport.subscribe

---

unsubscribe()

protected unsubscribe(event, handler): void

Defined in: transports/broadcast-transport.ts:156

Unsubscribe from transport messages

Parameters

Parameter	Type
event	string
handler	(data) => void

Returns

void

Overrides

Transport.unsubscribe