Welshman Docs / @welshman/app / Handles

Class: Handles

Defined in: app/src/plugins/handles.ts:18

NIP-05 handles, keyed by nip05 identifier. A "local" loadable collection: items aren't nostr events, they're fetched over HTTP (either directly from each domain's .well-known/nostr.json, or via a dufflepud proxy to protect user privacy). Depends on the profiles collection to resolve a pubkey's handle.

Extends

• LoadableMapPlugin<Handle>

Constructors

Constructor

new Handles(app, options): Handles

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

Parameters

app

IApp

options

MakeLoadItemOptions = {}

Returns

Handles

Inherited from

LoadableMapPlugin.constructor

Properties

all

all: Projection<Handle[]>

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

---

fetch()

fetch: (request) => Promise<undefined | Handle>

Defined in: app/src/plugins/handles.ts:19

Parameters

request

string

Returns

Promise<undefined | Handle>

Overrides

LoadableMapPlugin.fetch

---

forceLoad()

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

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

Parameters

key

string

args

...any[]

Returns

Promise<Maybe<Handle>>

Inherited from

LoadableMapPlugin.forceLoad

---

index

index: Projection<ItemsByKey<Handle>>

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

Inherited from

LoadableMapPlugin.index

---

load()

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

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

Parameters

key

string

args

...any[]

Returns

Promise<Maybe<Handle>>

Inherited from

LoadableMapPlugin.load

---

one()

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

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

Parameters

key?

string

args?

...any[]

Returns

Readable<Maybe<Handle>>

Inherited from

LoadableMapPlugin.one

---

store

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

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

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(nip05): string

Defined in: app/src/plugins/handles.ts:88

Parameters

nip05

string

Returns

string

---

emitItem()

protected emitItem(key, value): void

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

Parameters

key

string

value

Maybe<Handle>

Returns

void

Inherited from

LoadableMapPlugin.emitItem

---

forPubkey()

forPubkey(pubkey, relays): Projection<Maybe<Handle>>

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

Parameters

pubkey

string

relays

string[] = []

Returns

Projection<Maybe<Handle>>

---

get()

get(key): undefined | Handle

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

Parameters

key

string

Returns

undefined | Handle

Inherited from

LoadableMapPlugin.get

---

loadForPubkey()

loadForPubkey(pubkey, relays): Promise<Maybe<Handle>>

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

Parameters

pubkey

string

relays

string[] = []

Returns

Promise<Maybe<Handle>>

---

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

Handle

Returns

void

Inherited from

LoadableMapPlugin.set