Welshman

Appearance

Welshman Docs / @welshman/app / BookmarkSets

Class: BookmarkSets ​

Defined in: plugins/bookmarkSets.ts:19

NIP-51 bookmark sets (kind 30003), many per author, keyed by address.

Extends ​

Constructors ​

Constructor ​

new BookmarkSets(app): BookmarkSets

Defined in: plugins/bookmarkSets.ts:20

Parameters ​

app ​

IApp

Returns ​

BookmarkSets

Overrides ​

DerivedPlugin.constructor

Properties ​

all ​

all: Projection<BookmarkSetReader[]>

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

Defined in: plugins/base.ts:170

Parameters ​

key ​

string

args ​

...any[]

Returns ​

Promise<Maybe<BookmarkSetReader>>

Inherited from ​

DerivedPlugin.forceLoad

index ​

readonly index: ItemCollection<BookmarkSetReader>

Defined in: plugins/base.ts:176

Inherited from ​

DerivedPlugin.index

load ​

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

Defined in: plugins/base.ts:169

Parameters ​

key ​

string

args ​

...any[]

Returns ​

Promise<Maybe<BookmarkSetReader>>

Inherited from ​

DerivedPlugin.load

one ​

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

Defined in: plugins/base.ts:168

Parameters ​

key? ​

string

args ​

...any[]

Returns ​

Readable<Maybe<BookmarkSetReader>>

Inherited from ​

DerivedPlugin.one

Methods ​

create() ​

create(fields): Promise<Command>

Defined in: plugins/bookmarkSets.ts:42

Parameters ​

fields ​

BookmarkSetFields

Returns ​

Promise<Command>

fetch() ​

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

Defined in: plugins/bookmarkSets.ts:28

Parameters ​

address ​

string

relayHints? ​

string[] = []

Returns ​

Promise<TrustedEvent | undefined>

Overrides ​

DerivedPlugin.fetch

forAuthor() ​

forAuthor(pubkey): Projection<BookmarkSetReader[]>

Defined in: plugins/bookmarkSets.ts:36

Parameters ​

pubkey ​

string

Returns ​

Projection<BookmarkSetReader[]>

get() ​

get(key): BookmarkSetReader | undefined

Defined in: plugins/base.ts:190

Parameters ​

key ​

string

Returns ​

BookmarkSetReader | undefined

Inherited from ​

DerivedPlugin.get

loadForAuthor() ​

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

Defined in: plugins/bookmarkSets.ts:39

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

update() ​

update(address, fn): Promise<Command>

Defined in: plugins/bookmarkSets.ts:51

Parameters ​

address ​

string

fn ​

(writer) => void

Returns ​

Promise<Command>