NostrWSClient.md

nostr-websocket-utils v0.3.16

---

nostr-websocket-utils / NostrWSClient

Class: NostrWSClient

Defined in: core/client.ts:14

NostrWSClient handles WebSocket connections to Nostr relays

Constructors

Constructor

new NostrWSClient(relayUrls, options?): NostrWSClient

Defined in: core/client.ts:22

Parameters

relayUrls

string[]

options?

NostrWSClientOptions = {}

Returns

NostrWSClient

Properties

ws

private ws: WebSocket | null = null

Defined in: core/client.ts:15

---

queue

private readonly queue: MessageQueue

Defined in: core/client.ts:16

---

logger

private readonly logger: Logger

Defined in: core/client.ts:17

---

connectionState

private connectionState: ConnectionState = ConnectionState.DISCONNECTED

Defined in: core/client.ts:18

---

reconnectAttempts

private reconnectAttempts: number = 0

Defined in: core/client.ts:19

---

reconnectTimeout

private reconnectTimeout: Timeout | null = null

Defined in: core/client.ts:20

---

relayUrls

private readonly relayUrls: string[]

Defined in: core/client.ts:23

---

options

private readonly options: NostrWSClientOptions = {}

Defined in: core/client.ts:24

Methods

connect()

connect(): Promise<void>

Defined in: core/client.ts:51

Connect to the relay

Returns

Promise<void>

---

disconnect()

disconnect(): Promise<void>

Defined in: core/client.ts:113

Disconnect from the relay

Returns

Promise<void>

---

sendMessage()

sendMessage(message): Promise<void>

Defined in: core/client.ts:137

Send a message to the relay

Parameters

message

NostrWSMessage

Returns

Promise<void>

---

handleMessage()

private handleMessage(data): void

Defined in: core/client.ts:145

Parameters

data

Data

Returns

void

---

handleDisconnect()

private handleDisconnect(): void

Defined in: core/client.ts:161

Returns

void

---

getConnectionState()

getConnectionState(): ConnectionState

Defined in: core/client.ts:197

Get the current connection state

Returns

ConnectionState