Welshman Docs / @welshman/app / PinLists

Class: PinLists

Defined in: plugins/pins.ts:12

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

Extends

• DerivedPlugin<PinListReader>

Constructors

Constructor

new PinLists(app): PinLists

Defined in: plugins/pins.ts:13

Parameters

app

IApp

Returns

PinLists

Overrides

DerivedPlugin.constructor

Properties

all

all: Projection<PinListReader[]>

Defined in: plugins/base.ts:167

Inherited from

DerivedPlugin.all

---

app

protected readonly app: IApp

Defined in: plugins/base.ts:175

Inherited from

DerivedPlugin.app

---

forceLoad

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

Defined in: plugins/base.ts:170

Parameters

key

string

args

...any[]

Returns

Promise<Maybe<PinListReader>>

Inherited from

DerivedPlugin.forceLoad

---

index

readonly index: ItemCollection<PinListReader>

Defined in: plugins/base.ts:176

Inherited from

DerivedPlugin.index

---

load

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

Defined in: plugins/base.ts:169

Parameters

key

string

args

...any[]

Returns

Promise<Maybe<PinListReader>>

Inherited from

DerivedPlugin.load

---

one

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

Defined in: plugins/base.ts:168

Parameters

key?

string

args

...any[]

Returns

Readable<Maybe<PinListReader>>

Inherited from

DerivedPlugin.one

Methods

fetch()

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

Defined in: plugins/pins.ts:21

Parameters

pubkey

string

relayHints?

string[] = []

Returns

Promise<TrustedEvent | undefined>

Overrides

DerivedPlugin.fetch

---

get()

get(key): PinListReader | undefined

Defined in: plugins/base.ts:190

Parameters

key

string

Returns

PinListReader | undefined

Inherited from

DerivedPlugin.get

---

pin()

pin(tag): Promise<Command>

Defined in: plugins/pins.ts:28

Parameters

tag

string[]

Returns

Promise<Command>

---

project()

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

Defined in: plugins/base.ts:192

Type Parameters

U

U

Parameters

key

string

read

(item) => U

Returns

Projection<U>

Inherited from

DerivedPlugin.project

---

unpin()

unpin(value): Promise<Command>

Defined in: plugins/pins.ts:30

Parameters

value

string

Returns

Promise<Command>

---

update()

update(fn): Promise<Command>

Defined in: plugins/pins.ts:25

Parameters

fn

(writer) => void

Returns

Promise<Command>