Welshman Docs / @welshman/app / Pins

Class: Pins

Defined in: app/src/plugins/pinboards.ts:73

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: app/src/plugins/pinboards.ts:74

Parameters

app

IApp

Returns

Pins

Overrides

DerivedPlugin.constructor

Properties

all

all: Projection<PinReader[]>

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

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

Parameters

key

string

args

...any[]

Returns

Promise<Maybe<PinReader>>

Inherited from

DerivedPlugin.forceLoad

---

index

index: Projection<ItemsByKey<PinReader>>

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

Inherited from

DerivedPlugin.index

---

load()

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

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

Parameters

key

string

args

...any[]

Returns

Promise<Maybe<PinReader>>

Inherited from

DerivedPlugin.load

---

one()

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

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

Parameters

key?

string

args?

...any[]

Returns

Readable<Maybe<PinReader>>

Inherited from

DerivedPlugin.one

Methods

addToBoard()

addToBoard(address, board): Promise<Command>

Defined in: app/src/plugins/pinboards.ts:128

Parameters

address

string

board

string

Returns

Promise<Command>

---

create()

create(writer): Promise<Command>

Defined in: app/src/plugins/pinboards.ts:112

Parameters

writer

PinWriter

Returns

Promise<Command>

---

fetch()

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

Defined in: app/src/plugins/pinboards.ts:82

Parameters

address

string

relayHints

string[] = []

Returns

Promise<undefined | TrustedEvent>

Overrides

DerivedPlugin.fetch

---

forBoard()

forBoard(address): Projection<PinReader[]>

Defined in: app/src/plugins/pinboards.ts:90

Parameters

address

string

Returns

Projection<PinReader[]>

---

forProfile()

forProfile(pubkey): Projection<PinReader[]>

Defined in: app/src/plugins/pinboards.ts:93

Parameters

pubkey

string

Returns

Projection<PinReader[]>

---

get()

get(key): undefined | PinReader

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

Parameters

key

string

Returns

undefined | PinReader

Inherited from

DerivedPlugin.get

---

loadForBoard()

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

Defined in: app/src/plugins/pinboards.ts:98

Parameters

address

string

relayHints

string[] = []

Returns

Promise<TrustedEvent[]>

---

loadForProfile()

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

Defined in: app/src/plugins/pinboards.ts:109

Parameters

pubkey

string

relayHints

string[] = []

Returns

Promise<TrustedEvent[]>

---

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

---

removeFromBoard()

removeFromBoard(address, board): Promise<Command>

Defined in: app/src/plugins/pinboards.ts:131

Parameters

address

string

board

string

Returns

Promise<Command>

---

update()

update(address, fn): Promise<Command>

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

Parameters

address

string

fn

(writer) => void

Returns

Promise<Command>