nostr-websocket-utils

nostr-websocket-utils v0.3.16

---

nostr-websocket-utils / NostrWSClientEvents

Interface: NostrWSClientEvents

Defined in: types/index.ts:110

Events emitted by the NostrWSClient

Properties

connect()

connect: () => void

Defined in: types/index.ts:114

Emitted when the client connects to the relay

Returns

void

---

disconnect()

disconnect: () => void

Defined in: types/index.ts:119

Emitted when the client disconnects from the relay

Returns

void

---

reconnect()

reconnect: () => void

Defined in: types/index.ts:124

Emitted when the client reconnects to the relay

Returns

void

---

message()

message: (message) => Promise<void>

Defined in: types/index.ts:130

Emitted when a message is received from the relay

Parameters

message

NostrWSMessage

The received message

Returns

Promise<void>

---

error()

error: (error) => void

Defined in: types/index.ts:136

Emitted when an error occurs

Parameters

error

Error

The error that occurred

Returns

void

---

close()

close: () => void

Defined in: types/index.ts:137

Returns

void

---

stateChange()?

optional stateChange: (state) => void

Defined in: types/index.ts:138

Parameters

state

ConnectionState

Returns

void

---

heartbeat()?

optional heartbeat: () => void

Defined in: types/index.ts:139

Returns

void

This site is open source. Improve this page.