NostrWSClientEvents.md

nostr-websocket-utils v0.3.0

---

nostr-websocket-utils / NostrWSClientEvents

Interface: NostrWSClientEvents

Events emitted by the NostrWSClient

Properties

connect()

connect: () => void

Emitted when the client connects to the relay

Returns

void

Defined in

types/index.ts:106

---

disconnect()

disconnect: () => void

Emitted when the client disconnects from the relay

Returns

void

Defined in

types/index.ts:111

---

reconnect()

reconnect: () => void

Emitted when the client reconnects to the relay

Returns

void

Defined in

types/index.ts:116

---

message()

message: (message) => Promise<void>

Emitted when a message is received from the relay

Parameters

message

NostrWSMessage

The received message

Returns

Promise<void>

Defined in

types/index.ts:122

---

error()

error: (error) => void

Emitted when an error occurs

Parameters

error

Error

The error that occurred

Returns

void

Defined in

types/index.ts:128

---

close()

close: () => void

Returns

void

Defined in

types/index.ts:129

---

stateChange()?

optional stateChange: (state) => void

Parameters

state

ConnectionState

Returns

void

Defined in

types/index.ts:130

---

heartbeat()?

optional heartbeat: () => void

Returns

void

Defined in

types/index.ts:131