NostrWSOptions.md

nostr-websocket-utils v0.3.16

---

nostr-websocket-utils / NostrWSOptions

Interface: NostrWSOptions

Defined in: types/index.ts:76

WebSocket client options

Properties

WebSocketImpl?

optional WebSocketImpl: typeof WebSocket

Defined in: types/index.ts:77

---

connectionTimeout?

optional connectionTimeout: number

Defined in: types/index.ts:78

---

retryAttempts?

optional retryAttempts: number

Defined in: types/index.ts:79

---

retryDelay?

optional retryDelay: number

Defined in: types/index.ts:80

---

onMessage()?

optional onMessage: (message) => void

Defined in: types/index.ts:81

Parameters

message

string

Returns

void

---

onError()?

optional onError: (error) => void

Defined in: types/index.ts:82

Parameters

error

Error

Returns

void

---

retry?

optional retry: Partial<RetryConfig>

Defined in: types/index.ts:83

---

queue?

optional queue: Partial<QueueConfig>

Defined in: types/index.ts:84

---

heartbeat?

optional heartbeat: Partial<HeartbeatConfig>

Defined in: types/index.ts:85

---

autoReconnect?

optional autoReconnect: boolean

Defined in: types/index.ts:86

---

bufferMessages?

optional bufferMessages: boolean

Defined in: types/index.ts:87

---

cleanStaleMessages?

optional cleanStaleMessages: boolean

Defined in: types/index.ts:88

---

logger?

optional logger: Logger

Defined in: types/index.ts:89