Welshman Docs / @welshman/app / Pins

Class: Pins

Defined in: plugins/pinboards.ts:74

Pinboards-NIP kind-39067 pins, keyed by address. A pin belongs to zero or more boards via A tags; one with none is a profile pin.

Extends

• DerivedPlugin<PinReader>

Constructors

Constructor

new Pins(app): Pins

Defined in: plugins/pinboards.ts:75

Parameters

app

IApp

Returns

Pins

Overrides

DerivedPlugin.constructor

Properties

all

all: Projection<PinReader[]>

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

Defined in: plugins/base.ts:170

Parameters

key

string

args

...any[]

Returns

Promise<Maybe<PinReader>>

Inherited from

DerivedPlugin.forceLoad

---

index

readonly index: ItemCollection<PinReader>

Defined in: plugins/base.ts:176

Inherited from

DerivedPlugin.index

---

load

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

Defined in: plugins/base.ts:169

Parameters

key

string

args

...any[]

Returns

Promise<Maybe<PinReader>>

Inherited from

DerivedPlugin.load

---

one

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

Defined in: plugins/base.ts:168

Parameters

key?

string

args

...any[]

Returns

Readable<Maybe<PinReader>>

Inherited from

DerivedPlugin.one

Methods

addToBoard()

addToBoard(address, board): Promise<Command>

Defined in: plugins/pinboards.ts:129

Parameters

address

string

board

string

Returns

Promise<Command>

---

create()

create(writer): Promise<Command>

Defined in: plugins/pinboards.ts:113

Parameters

writer

PinWriter

Returns

Promise<Command>

---

fetch()

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

Defined in: plugins/pinboards.ts:83

Parameters

address

string

relayHints?

string[] = []

Returns

Promise<TrustedEvent | undefined>

Overrides

DerivedPlugin.fetch

---

forBoard()

forBoard(address): Projection<PinReader[]>

Defined in: plugins/pinboards.ts:91

Parameters

address

string

Returns

Projection<PinReader[]>

---

forProfile()

forProfile(pubkey): Projection<PinReader[]>

Defined in: plugins/pinboards.ts:94

Parameters

pubkey

string

Returns

Projection<PinReader[]>

---

get()

get(key): PinReader | undefined

Defined in: plugins/base.ts:190

Parameters

key

string

Returns

PinReader | undefined

Inherited from

DerivedPlugin.get

---

loadForBoard()

loadForBoard(address, relayHints?): Promise<TrustedEvent[]>

Defined in: plugins/pinboards.ts:99

Parameters

address

string

relayHints?

string[] = []

Returns

Promise<TrustedEvent[]>

---

loadForProfile()

loadForProfile(pubkey, relayHints?): Promise<TrustedEvent[]>

Defined in: plugins/pinboards.ts:110

Parameters

pubkey

string

relayHints?

string[] = []

Returns

Promise<TrustedEvent[]>

---

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

---

removeFromBoard()

removeFromBoard(address, board): Promise<Command>

Defined in: plugins/pinboards.ts:132

Parameters

address

string

board

string

Returns

Promise<Command>

---

update()

update(address, fn): Promise<Command>

Defined in: plugins/pinboards.ts:117

Parameters

address

string

fn

(writer) => void

Returns

Promise<Command>