Welshman Docs / @welshman/app / Relays

Class: Relays

Defined in: app/src/plugins/relays.ts:14

NIP-11 relay profiles, keyed by url. A "local" loadable collection: items aren't nostr events, they're fetched over HTTP from each relay.

Extends

• LoadableMapPlugin<Relay>

Constructors

Constructor

new Relays(app, options): Relays

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

Parameters

app

IApp

options

MakeLoadItemOptions = {}

Returns

Relays

Inherited from

LoadableMapPlugin.constructor

Properties

all

all: Projection<Relay[]>

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

Inherited from

LoadableMapPlugin.all

---

app

protected readonly app: IApp

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

Inherited from

LoadableMapPlugin.app

---

forceLoad()

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

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

Parameters

key

string

args

...any[]

Returns

Promise<Maybe<Relay>>

Inherited from

LoadableMapPlugin.forceLoad

---

index

index: Projection<ItemsByKey<Relay>>

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

Inherited from

LoadableMapPlugin.index

---

load()

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

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

Parameters

key

string

args

...any[]

Returns

Promise<Maybe<Relay>>

Inherited from

LoadableMapPlugin.load

---

one()

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

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

Parameters

key?

string

args?

...any[]

Returns

Readable<Maybe<Relay>>

Inherited from

LoadableMapPlugin.one

---

relaySearch

relaySearch: Readable<Search<string, Relay>>

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

---

store

protected store: Writable<Map<string, Relay>>

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

Inherited from

LoadableMapPlugin.store

---

subs

subs: (key, value) => void[] = []

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

Parameters

key

string

value

Maybe<Relay>

Returns

void

Inherited from

LoadableMapPlugin.subs

Methods

clear()

clear(): void

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

Returns

void

Inherited from

LoadableMapPlugin.clear

---

delete()

delete(key): void

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

Parameters

key

string

Returns

void

Inherited from

LoadableMapPlugin.delete

---

display()

display(url): Projection<string>

Defined in: app/src/plugins/relays.ts:63

Parameters

url

string

Returns

Projection<string>

---

emitItem()

protected emitItem(key, value): void

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

Parameters

key

string

value

Maybe<Relay>

Returns

void

Inherited from

LoadableMapPlugin.emitItem

---

fetch()

fetch(url): Promise<Maybe<Relay>>

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

Parameters

url

string

Returns

Promise<Maybe<Relay>>

Overrides

LoadableMapPlugin.fetch

---

get()

get(key): undefined | Relay

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

Parameters

key

string

Returns

undefined | Relay

Inherited from

LoadableMapPlugin.get

---

hasNegentropy()

hasNegentropy(url): Promise<boolean>

Defined in: app/src/plugins/relays.ts:66

Parameters

url

string

Returns

Promise<boolean>

---

hasNip()

hasNip(url, nip): Promise<boolean>

Defined in: app/src/plugins/relays.ts:68

Parameters

url

string

nip

string | number

Returns

Promise<boolean>

---

onItem()

onItem(subscriber): Unsubscriber

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

Parameters

subscriber

(key, value) => void

Returns

Unsubscriber

Inherited from

LoadableMapPlugin.onItem

---

project()

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

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

Type Parameters

U

U

Parameters

key

string

read

(item) => U

Returns

Projection<U>

Inherited from

LoadableMapPlugin.project

---

set()

set(key, value): void

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

Parameters

key

string

value

Relay

Returns

void

Inherited from

LoadableMapPlugin.set