@zturnlibs/ztron-api

---

websocket#

Variables#

websocket#

const websocket: object

Defined in: websocket.ts:43

Type Declaration#

connect#

connect: (url) => Promise<{ id: number; }>

Opens a WebSocket connection; resolves with a connection id.

Parameters#

url#

string

Returns#

Promise<{ id: number; }>

disconnect#

disconnect: (id) => Promise<void>

Closes a connection.

Parameters#

id#

number

Returns#

Promise<void>

onMessage#

onMessage: (handler) => Promise<() => Promise<void>>

Listens for incoming messages: handler({ id, message }).

Parameters#

handler#

(event) => void

Returns#

Promise<() => Promise<void>>

onStatus#

onStatus: (handler) => Promise<() => Promise<void>>

Listens for connection state changes: handler({ id, state }).

Parameters#

handler#

(event) => void

Returns#

Promise<() => Promise<void>>

sendMessage#

sendMessage: (id, message) => Promise<void>

Sends a text message on a connection.

Parameters#

id#

number

message#

string

Returns#

Promise<void>

Functions#

connect()#

connect(url): Promise<{ id: number; }>

Defined in: websocket.ts:9

Opens a WebSocket connection; resolves with a connection id.

Parameters#

url#

string

Returns#

Promise<{ id: number; }>

---

disconnect()#

disconnect(id): Promise<void>

Defined in: websocket.ts:19

Closes a connection.

Parameters#

id#

number

Returns#

Promise<void>

---

onMessage()#

onMessage(handler): Promise<() => Promise<void>>

Defined in: websocket.ts:24

Listens for incoming messages: handler({ id, message }).

Parameters#

handler#

(event) => void

Returns#

Promise<() => Promise<void>>

---

onStatus()#

onStatus(handler): Promise<() => Promise<void>>

Defined in: websocket.ts:34

Listens for connection state changes: handler({ id, state }).

Parameters#

handler#

(event) => void

Returns#

Promise<() => Promise<void>>

---

sendMessage()#

sendMessage(id, message): Promise<void>

Defined in: websocket.ts:14

Sends a text message on a connection.

Parameters#

id#

number

message#

string

Returns#

Promise<void>