Welshman Docs / @welshman/app / RelayLists

Class: RelayLists

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

NIP-65 relay lists, keyed by pubkey. This is the routing substrate every other outbox-model load depends on (see Network.loadUsingOutbox).

Extends

• DerivedPlugin<RelayListReader>

Constructors

Constructor

new RelayLists(app): RelayLists

Defined in: app/src/plugins/relayLists.ts:17

Parameters

app

IApp

Returns

RelayLists

Overrides

DerivedPlugin.constructor

Properties

all

all: Projection<RelayListReader[]>

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<RelayListReader>>

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

Parameters

key

string

args

...any[]

Returns

Promise<Maybe<RelayListReader>>

Inherited from

DerivedPlugin.forceLoad

---

index

index: Projection<ItemsByKey<RelayListReader>>

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

Inherited from

DerivedPlugin.index

---

load()

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

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

Parameters

key

string

args

...any[]

Returns

Promise<Maybe<RelayListReader>>

Inherited from

DerivedPlugin.load

---

one()

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

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

Parameters

key?

string

args?

...any[]

Returns

Readable<Maybe<RelayListReader>>

Inherited from

DerivedPlugin.one

Methods

addReadUrl()

addReadUrl(url): Promise<Command>

Defined in: app/src/plugins/relayLists.ts:54

Parameters

url

string

Returns

Promise<Command>

---

addWriteUrl()

addWriteUrl(url): Promise<Command>

Defined in: app/src/plugins/relayLists.ts:56

Parameters

url

string

Returns

Promise<Command>

---

fetch()

fetch(pubkey, hints): Promise<TrustedEvent[]>

Defined in: app/src/plugins/relayLists.ts:25

Parameters

pubkey

string

hints

string[] = []

Returns

Promise<TrustedEvent[]>

Overrides

DerivedPlugin.fetch

---

get()

get(key): undefined | RelayListReader

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

Parameters

key

string

Returns

undefined | RelayListReader

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

---

readUrls()

readUrls(pubkey): Projection<string[]>

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

Parameters

pubkey

string

Returns

Projection<string[]>

---

removeReadUrl()

removeReadUrl(url): Promise<Command>

Defined in: app/src/plugins/relayLists.ts:58

Parameters

url

string

Returns

Promise<Command>

---

removeWriteUrl()

removeWriteUrl(url): Promise<Command>

Defined in: app/src/plugins/relayLists.ts:60

Parameters

url

string

Returns

Promise<Command>

---

setReadUrls()

setReadUrls(urls): Promise<Command>

Defined in: app/src/plugins/relayLists.ts:62

Parameters

urls

string[]

Returns

Promise<Command>

---

setWriteUrls()

setWriteUrls(urls): Promise<Command>

Defined in: app/src/plugins/relayLists.ts:64

Parameters

urls

string[]

Returns

Promise<Command>

---

update()

update(fn): Promise<Command>

Defined in: app/src/plugins/relayLists.ts:45

Parameters

fn

(writer) => void

Returns

Promise<Command>

---

urls()

urls(pubkey): Projection<string[]>

Defined in: app/src/plugins/relayLists.ts:37

Parameters

pubkey

string

Returns

Projection<string[]>

---

writeUrls()

writeUrls(pubkey): Projection<string[]>

Defined in: app/src/plugins/relayLists.ts:42

Parameters

pubkey

string

Returns

Projection<string[]>