Class Connection

Hierarchy

EventEmitter<ConnectionEvents>
- Connection

Constructors

constructor

new Connection(addr, options, ephemeral?): Connection
Parameters
- addr: string
- options: RelaySettings
- ephemeral: boolean = false
Returns Connection
Overrides EventEmitter<ConnectionEvents>.constructor
- Defined in packages/system/src/connection.ts:92

Properties

`Private` #activity

#activity: number = ...

`Private` #ephemeral

#ephemeral: boolean

`Private` `Optional` #ephemeralCheck

#ephemeralCheck?: Timeout

`Private` #expectAuth

#expectAuth: boolean = false

`Private` #log

#log: Debugger

ActiveRequests

ActiveRequests: Set<string> = ...

Address

Address: string

Authed

Authed: boolean = false

AwaitingAuth

AwaitingAuth: Map<string, boolean>

ConnectTimeout

ConnectTimeout: number = DefaultConnectTimeout

Down

Down: boolean = true

EventsCallback

EventsCallback: Map<string, ((msg) => void)>

Type declaration

- (msg): void
- Parameters
  - msg: (string | boolean)[]
  Returns void

HasStateChange

HasStateChange: boolean = true

Id

Id: string

`Optional` Info

Info?: RelayInfo

IsClosed

IsClosed: boolean

PendingRaw

PendingRaw: object[] = []

PendingRequests

PendingRequests: {
cb: (() => void);
cmd: [cmd: "REQ", id: string, ...filters: ReqFilter[]];
}[] = []

Type declaration

cb: (() => void)
- - (): void
  - Returns void
cmd: [cmd: "REQ", id: string, ...filters: ReqFilter[]]

`Optional` ReconnectTimer

ReconnectTimer?: Timeout

Settings

Settings: RelaySettings

Socket

Socket: null | WebSocket = null

Stats

Stats: ConnectionStats = ...

`Static` prefixed

prefixed: string | boolean

Accessors

`Private` #maxSubscriptions

get #maxSubscriptions(): number
Returns number
- Defined in packages/system/src/connection.ts:502

Ephemeral

get Ephemeral(): boolean
Returns boolean
- Defined in packages/system/src/connection.ts:104
set Ephemeral(v): void
Parameters
- v: boolean
Returns void
- Defined in packages/system/src/connection.ts:108

Methods

`Private` #SendQueuedRequests

#SendQueuedRequests(): void
Returns void
- Defined in packages/system/src/connection.ts:411

`Private` #onAuthAsync

#onAuthAsync(challenge): Promise<void>
Parameters
- challenge: string
Returns Promise<void>
- Defined in packages/system/src/connection.ts:469

`Private` #reset

#reset(): void
Returns void
- Defined in packages/system/src/connection.ts:426

`Private` #sendJson

#sendJson(obj): undefined | false
Parameters
- obj: object
Returns undefined | false
- Defined in packages/system/src/connection.ts:436

`Private` #sendOnWire

#sendOnWire(obj): boolean
Parameters
- obj: unknown
Returns boolean
- Defined in packages/system/src/connection.ts:459

`Private` #sendPendingRaw

#sendPendingRaw(): void
Returns void
- Defined in packages/system/src/connection.ts:450

`Private` #setupEphemeral

#setupEphemeral(): void
Returns void
- Defined in packages/system/src/connection.ts:506

Close

Close(): void
Returns void
- Defined in packages/system/src/connection.ts:153

CloseReq

CloseReq(id): void
Parameters
- id: string
Returns void
- Defined in packages/system/src/connection.ts:381

Connect

Connect(): Promise<void>
Returns Promise<void>
- Defined in packages/system/src/connection.ts:113

OnClose

OnClose(e): void
Parameters
- e: CloseEvent
Returns void
- Defined in packages/system/src/connection.ts:168

OnError

OnError(e): void
Parameters
- e: Event
Returns void
- Defined in packages/system/src/connection.ts:276

OnMessage

OnMessage(e): void
Parameters
- e: MessageEvent
Returns void
- Defined in packages/system/src/connection.ts:201

OnOpen

OnOpen(wasReconnect): void
Parameters
- wasReconnect: boolean
Returns void
- Defined in packages/system/src/connection.ts:159

QueueReq

QueueReq(cmd, cbSent): void
Queue or send command to the relay
Parameters
- cmd: [cmd: "REQ", id: string, ...filters: ReqFilter[]]
  The REQ to send to the server
- cbSent: (() => void)
  - - (): void
    - Returns void
Returns void
- Defined in packages/system/src/connection.ts:355

SendAsync

SendAsync(e, timeout?): Promise<OkResponse>
Send event on this connection and wait for OK response
Parameters
- e: NostrEvent
- timeout: number = 5000
Returns Promise<OkResponse>
- Defined in packages/system/src/connection.ts:297

SendEvent

SendEvent(e): void
Send event on this connection
Parameters
- e: NostrEvent
Returns void
- Defined in packages/system/src/connection.ts:284

SupportsNip

SupportsNip(n): boolean
Using relay document to determine if this relay supports a feature
Parameters
- n: number
Returns boolean
- Defined in packages/system/src/connection.ts:347

addListener

addListener<T>(event, fn, context?): this
Type Parameters
- T extends keyof ConnectionEvents
Parameters
- event: T
- fn: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: ArgumentMap<ConnectionEvents>[Extract<T, keyof ConnectionEvents>]
      Returns void
- Optional context: any
Returns this
Inherited from EventEmitter.addListener
- Defined in .yarn/cache/eventemitter3-npm-5.0.1-5e423b7df3-543d6c858a.zip/node_modules/eventemitter3/index.d.ts:45

emit

emit<T>(event, ...args): boolean
Calls each of the listeners registered for a given event.
Type Parameters
- T extends keyof ConnectionEvents
Parameters
- event: T
- Rest ...args: ArgumentMap<ConnectionEvents>[Extract<T, keyof ConnectionEvents>]
Returns boolean
Inherited from EventEmitter.emit
- Defined in .yarn/cache/eventemitter3-npm-5.0.1-5e423b7df3-543d6c858a.zip/node_modules/eventemitter3/index.d.ts:32

eventNames

eventNames(): (keyof ConnectionEvents)[]
Return an array listing the events for which the emitter has registered listeners.

Returns (keyof ConnectionEvents)[]
Inherited from EventEmitter.eventNames
- Defined in .yarn/cache/eventemitter3-npm-5.0.1-5e423b7df3-543d6c858a.zip/node_modules/eventemitter3/index.d.ts:15

listenerCount

listenerCount(event): number
Return the number of listeners listening to a given event.
Parameters
- event: keyof ConnectionEvents
Returns number
Inherited from EventEmitter.listenerCount
- Defined in .yarn/cache/eventemitter3-npm-5.0.1-5e423b7df3-543d6c858a.zip/node_modules/eventemitter3/index.d.ts:27

listeners

listeners<T>(event): ((...args) => void)[]
Return the listeners registered for a given event.
Type Parameters
- T extends keyof ConnectionEvents
Parameters
- event: T
Returns ((...args) => void)[]
Inherited from EventEmitter.listeners
- Defined in .yarn/cache/eventemitter3-npm-5.0.1-5e423b7df3-543d6c858a.zip/node_modules/eventemitter3/index.d.ts:20

notifyChange

notifyChange(): void
Returns void
- Defined in packages/system/src/connection.ts:525

off

off<T>(event, fn?, context?, once?): this
Type Parameters
- T extends keyof ConnectionEvents
Parameters
- event: T
- Optional fn: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: ArgumentMap<ConnectionEvents>[Extract<T, keyof ConnectionEvents>]
      Returns void
- Optional context: any
- Optional once: boolean
Returns this
Inherited from EventEmitter.off
- Defined in .yarn/cache/eventemitter3-npm-5.0.1-5e423b7df3-543d6c858a.zip/node_modules/eventemitter3/index.d.ts:69

on

on<T>(event, fn, context?): this
Add a listener for a given event.
Type Parameters
- T extends keyof ConnectionEvents
Parameters
- event: T
- fn: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: ArgumentMap<ConnectionEvents>[Extract<T, keyof ConnectionEvents>]
      Returns void
- Optional context: any
Returns this
Inherited from EventEmitter.on
- Defined in .yarn/cache/eventemitter3-npm-5.0.1-5e423b7df3-543d6c858a.zip/node_modules/eventemitter3/index.d.ts:40

once

once<T>(event, fn, context?): this
Add a one-time listener for a given event.
Type Parameters
- T extends keyof ConnectionEvents
Parameters
- event: T
- fn: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: ArgumentMap<ConnectionEvents>[Extract<T, keyof ConnectionEvents>]
      Returns void
- Optional context: any
Returns this
Inherited from EventEmitter.once
- Defined in .yarn/cache/eventemitter3-npm-5.0.1-5e423b7df3-543d6c858a.zip/node_modules/eventemitter3/index.d.ts:54

removeAllListeners

removeAllListeners(event?): this
Remove all listeners, or those of the specified event.
Parameters
- Optional event: keyof ConnectionEvents
Returns this
Inherited from EventEmitter.removeAllListeners
- Defined in .yarn/cache/eventemitter3-npm-5.0.1-5e423b7df3-543d6c858a.zip/node_modules/eventemitter3/index.d.ts:79

removeListener

removeListener<T>(event, fn?, context?, once?): this
Remove the listeners of a given event.
Type Parameters
- T extends keyof ConnectionEvents
Parameters
- event: T
- Optional fn: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: ArgumentMap<ConnectionEvents>[Extract<T, keyof ConnectionEvents>]
      Returns void
- Optional context: any
- Optional once: boolean
Returns this
Inherited from EventEmitter.removeListener
- Defined in .yarn/cache/eventemitter3-npm-5.0.1-5e423b7df3-543d6c858a.zip/node_modules/eventemitter3/index.d.ts:63

takeSnapshot

takeSnapshot(): ConnectionStateSnapshot
Returns ConnectionStateSnapshot
- Defined in packages/system/src/connection.ts:390

Class Connection

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

addr: string

options: RelaySettings

ephemeral: boolean = false

Returns Connection

Properties

Private #activity

Private #ephemeral

Private Optional #ephemeralCheck

Private #expectAuth

Private #log

ActiveRequests

Address

Authed

AwaitingAuth

ConnectTimeout

Down

EventsCallback

Type declaration

Parameters

msg: (string | boolean)[]

Returns void

HasStateChange

Id

Optional Info

IsClosed

PendingRaw

PendingRequests

Type declaration

cb: (() => void)

Returns void

cmd: [cmd: "REQ", id: string, ...filters: ReqFilter[]]

Optional ReconnectTimer

Settings

Socket

Stats

Static prefixed

Accessors

Private #maxSubscriptions

Returns number

Ephemeral

Returns boolean

Parameters

v: boolean

Returns void

Methods

Private #SendQueuedRequests

Returns void

Private #onAuthAsync

Parameters

challenge: string

Returns Promise<void>

Private #reset

Returns void

Private #sendJson

Parameters

obj: object

Returns undefined | false

Private #sendOnWire

Parameters

obj: unknown

Returns boolean

Private #sendPendingRaw

Returns void

Private #setupEphemeral

Returns void

Close

Returns void

CloseReq

Parameters

id: string

`Private` #activity

`Private` #ephemeral

`Private` `Optional` #ephemeralCheck

`Private` #expectAuth

`Private` #log

`Optional` Info

`Optional` ReconnectTimer

`Static` prefixed

`Private` #maxSubscriptions

`Private` #SendQueuedRequests

`Private` #onAuthAsync

`Private` #reset

`Private` #sendJson

`Private` #sendOnWire

`Private` #sendPendingRaw

`Private` #setupEphemeral

`Rest` ...args: ArgumentMap<ConnectionEvents>[Extract<T, keyof ConnectionEvents>]

`Optional` context: any

`Rest` ...args: ArgumentMap<ConnectionEvents>[Extract<T, keyof ConnectionEvents>]