Welshman Docs / @welshman/app / Pinboards

Class: Pinboards

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

Pinboards-NIP kind-30067 boards, keyed by address (many boards per author).

Extends

• DerivedPlugin<PinboardReader>

Constructors

Constructor

new Pinboards(app): Pinboards

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

Parameters

app

IApp

Returns

Pinboards

Overrides

DerivedPlugin.constructor

Properties

all

all: Projection<PinboardReader[]>

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

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

Parameters

key

string

args

...any[]

Returns

Promise<Maybe<PinboardReader>>

Inherited from

DerivedPlugin.forceLoad

---

index

index: Projection<ItemsByKey<PinboardReader>>

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

Inherited from

DerivedPlugin.index

---

load()

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

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

Parameters

key

string

args

...any[]

Returns

Promise<Maybe<PinboardReader>>

Inherited from

DerivedPlugin.load

---

one()

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

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

Parameters

key?

string

args?

...any[]

Returns

Readable<Maybe<PinboardReader>>

Inherited from

DerivedPlugin.one

Methods

create()

create(fields): Promise<Command>

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

Parameters

fields

PinboardFields

Returns

Promise<Command>

---

fetch()

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

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

Parameters

address

string

relayHints

string[] = []

Returns

Promise<undefined | TrustedEvent>

Overrides

DerivedPlugin.fetch

---

forAuthor()

forAuthor(pubkey): Projection<PinboardReader[]>

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

Parameters

pubkey

string

Returns

Projection<PinboardReader[]>

---

get()

get(key): undefined | PinboardReader

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

Parameters

key

string

Returns

undefined | PinboardReader

Inherited from

DerivedPlugin.get

---

loadForAuthor()

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

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

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

---

update()

update(address, fn): Promise<Command>

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

Parameters

address

string

fn

(writer) => void

Returns

Promise<Command>