Class RelayMap

A collection of relay servers an endpoint should consider.

Index

Constructors

Methods

contains get insert isEmpty len remove toString urls empty fromUrls

Constructors

constructor

new RelayMap(): RelayMap

Returns RelayMap

Methods

contains

contains(url: string): boolean
Check whether the given relay URL is in the map.
Parameters
- url: string
Returns boolean
- Defined in index.d.ts:217

get

get(url: string): RelayConfig
Look up the configuration for the given relay URL.
Parameters
- url: string
Returns RelayConfig
- Defined in index.d.ts:219

insert

insert(config: RelayConfig): void
Insert a relay (replacing any prior entry for the same URL).
Parameters
- config: RelayConfig
Returns void
- Defined in index.d.ts:213

isEmpty

isEmpty(): boolean
True if the map has no relays.

Returns boolean
- Defined in index.d.ts:225

len

len(): number
Number of relays in the map.

Returns number
- Defined in index.d.ts:223

remove

remove(url: string): boolean
Remove the entry for the given relay URL. Returns true if removed.
Parameters
- url: string
Returns boolean
- Defined in index.d.ts:215

toString

toString(): string
Clean string representation.

Returns string
- Defined in index.d.ts:227

urls

urls(): string[]
All relay URLs currently in the map.

Returns string[]
- Defined in index.d.ts:221

`Static`empty

empty(): RelayMap
Create an empty relay map.

Returns RelayMap
- Defined in index.d.ts:209

`Static`fromUrls

fromUrls(urls: string[]): RelayMap
Build a relay map from a list of relay URLs.
Parameters
- urls: string[]
Returns RelayMap
- Defined in index.d.ts:211