Interface RelayDirectory

A live directory of monitored servers.

interface RelayDirectory {
    listings$: Observable<readonly RelayListing[]>;
    listings(): readonly RelayListing[];
    search(text: string, limit?: number): readonly RelayListing[];
    start(): void;
    stop(): void;
    suggest(options: SuggestOptions): readonly RelayListing[];
}

Index

Properties

Methods

listings search start stop suggest

Properties

`Readonly`listings$

listings$: Observable<readonly RelayListing[]>

Every listing, best first, replayed to new subscribers and re-emitted at most every throttleMs while reports stream in.

Methods

listings

listings(): readonly RelayListing[]

The listings as of now, best first.

Returns readonly RelayListing[]

search

search(text: string, limit?: number): readonly RelayListing[]
Listings whose address matches what the person typed, best first.
Parameters
- text: string
- Optionallimit: number
Returns readonly RelayListing[]

start

start(): void

Open the streaming subscription. Does nothing when already open.

Returns void

stop

stop(): void

Close it, keeping what was learned.

Returns void

suggest

suggest(options: SuggestOptions): readonly RelayListing[]
Servers to suggest for a purpose: the well-known fallback first, unless monitors say it refuses, then durable hosts from the directory.
Parameters
- options: SuggestOptions
Returns readonly RelayListing[]