Interface SuggestOptions

Options for RelayDirectory.suggest.

interface SuggestOptions {
    exclude?: readonly string[];
    limit?: number;
    purpose: SuggestPurpose;
}

Index

Properties

exclude? limit? purpose

Properties

`Optional` `Readonly`exclude

exclude?: readonly string[]

Servers already chosen, left out of the answer.

`Optional` `Readonly`limit

limit?: number

How many to suggest; 3 by default, the middle of NIP-65's 2–4.

`Readonly`purpose

purpose: SuggestPurpose