Class RelayMode

Configuration for which relay servers an endpoint uses.

Index

Constructors

Methods

relayMap toString custom customFromUrls defaultMode disabled staging

Constructors

constructor

new RelayMode(): RelayMode
Returns RelayMode

Methods

relayMap

relayMap(): RelayMap
The relay map this mode resolves to.

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

toString

toString(): string
Clean string representation.

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

`Static`custom

custom(map: RelayMap): RelayMode
Use a custom relay map.
Parameters
- map: RelayMap
Returns RelayMode
- Defined in index.d.ts:239

`Static`customFromUrls

customFromUrls(urls: string[]): RelayMode
Build a custom relay mode from a list of relay URLs.
Parameters
- urls: string[]
Returns RelayMode
- Defined in index.d.ts:241

`Static`defaultMode

defaultMode(): RelayMode
Use the n0 production relay map.

Returns RelayMode
- Defined in index.d.ts:235

`Static`disabled

disabled(): RelayMode
No relays.

Returns RelayMode
- Defined in index.d.ts:233

`Static`staging

staging(): RelayMode
Use the n0 staging relay map.

Returns RelayMode
- Defined in index.d.ts:237