Welshman

Appearance

Welshman Docs / @welshman/app / SearchRelayLists

Class: SearchRelayLists ​

Defined in: app/src/plugins/searchRelayLists.ts:15

NIP-51 search relay lists (kind 10007), keyed by pubkey. Loaded via the outbox model (the author's write relays), so it depends on the relay-list collection.

Extends ​

Constructors ​

Constructor ​

new SearchRelayLists(app): SearchRelayLists

Defined in: app/src/plugins/searchRelayLists.ts:16

Parameters ​

app ​

IApp

Returns ​

SearchRelayLists

Overrides ​

DerivedPlugin.constructor

Properties ​

all ​

all: Projection<SearchRelayListReader[]>

Defined in: app/src/plugins/base.ts:208

Inherited from ​

DerivedPlugin.all

app ​

protected readonly app: IApp

Defined in: app/src/plugins/base.ts:216

Inherited from ​

DerivedPlugin.app

forceLoad() ​

forceLoad: (key, ...args) => Promise<Maybe<SearchRelayListReader>>

Defined in: app/src/plugins/base.ts:211

Parameters ​

key ​

string

args ​

...any[]

Returns ​

Promise<Maybe<SearchRelayListReader>>

Inherited from ​

DerivedPlugin.forceLoad

index ​

index: Projection<ItemsByKey<SearchRelayListReader>>

Defined in: app/src/plugins/base.ts:207

Inherited from ​

DerivedPlugin.index

load() ​

load: (key, ...args) => Promise<Maybe<SearchRelayListReader>>

Defined in: app/src/plugins/base.ts:210

Parameters ​

key ​

string

args ​

...any[]

Returns ​

Promise<Maybe<SearchRelayListReader>>

Inherited from ​

DerivedPlugin.load

one() ​

one: (key?, ...args) => Readable<Maybe<SearchRelayListReader>>

Defined in: app/src/plugins/base.ts:209

Parameters ​

key? ​

string

args? ​

...any[]

Returns ​

Readable<Maybe<SearchRelayListReader>>

Inherited from ​

DerivedPlugin.one

Methods ​

addUrl() ​

addUrl(url): Promise<Command>

Defined in: app/src/plugins/searchRelayLists.ts:39

Parameters ​

url ​

string

Returns ​

Promise<Command>

fetch() ​

fetch(pubkey, relayHints): Promise<undefined | TrustedEvent>

Defined in: app/src/plugins/searchRelayLists.ts:24

Parameters ​

pubkey ​

string

relayHints ​

string[] = []

Returns ​

Promise<undefined | TrustedEvent>

Overrides ​

DerivedPlugin.fetch

get() ​

get(key): undefined | SearchRelayListReader

Defined in: app/src/plugins/base.ts:237

Parameters ​

key ​

string

Returns ​

undefined | SearchRelayListReader

Inherited from ​

DerivedPlugin.get

project() ​

project<U>(key, read): Projection<U>

Defined in: app/src/plugins/base.ts:239

Type Parameters ​

U ​

U

Parameters ​

key ​

string

read ​

(item) => U

Returns ​

Projection<U>

Inherited from ​

DerivedPlugin.project

removeUrl() ​

removeUrl(url): Promise<Command>

Defined in: app/src/plugins/searchRelayLists.ts:41

Parameters ​

url ​

string

Returns ​

Promise<Command>

setUrls() ​

setUrls(urls): Promise<Command>

Defined in: app/src/plugins/searchRelayLists.ts:43

Parameters ​

urls ​

string[]

Returns ​

Promise<Command>

update() ​

update(fn): Promise<Command>

Defined in: app/src/plugins/searchRelayLists.ts:30

Parameters ​

fn ​

(writer) => void

Returns ​

Promise<Command>

urls() ​

urls(pubkey): Projection<string[]>

Defined in: app/src/plugins/searchRelayLists.ts:28

Parameters ​

pubkey ​

string

Returns ​

Projection<string[]>