Welshman

Appearance

Welshman Docs / @welshman/app / BookmarkLists

Class: BookmarkLists ​

Defined in: plugins/bookmarkLists.ts:12

NIP-51 bookmark lists (kind 10003), keyed by pubkey. Private entries are NIP-44 encrypted, so decoding is asynchronous.

Extends ​

Constructors ​

Constructor ​

new BookmarkLists(app): BookmarkLists

Defined in: plugins/bookmarkLists.ts:13

Parameters ​

app ​

IApp

Returns ​

BookmarkLists

Overrides ​

DerivedPlugin.constructor

Properties ​

all ​

all: Projection<BookmarkListReader[]>

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

Defined in: plugins/base.ts:170

Parameters ​

key ​

string

args ​

...any[]

Returns ​

Promise<Maybe<BookmarkListReader>>

Inherited from ​

DerivedPlugin.forceLoad

index ​

readonly index: ItemCollection<BookmarkListReader>

Defined in: plugins/base.ts:176

Inherited from ​

DerivedPlugin.index

load ​

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

Defined in: plugins/base.ts:169

Parameters ​

key ​

string

args ​

...any[]

Returns ​

Promise<Maybe<BookmarkListReader>>

Inherited from ​

DerivedPlugin.load

one ​

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

Defined in: plugins/base.ts:168

Parameters ​

key? ​

string

args ​

...any[]

Returns ​

Readable<Maybe<BookmarkListReader>>

Inherited from ​

DerivedPlugin.one

Methods ​

bookmarkPrivately() ​

bookmarkPrivately(tag): Promise<Command>

Defined in: plugins/bookmarkLists.ts:30

Parameters ​

tag ​

string[]

Returns ​

Promise<Command>

bookmarkPublicly() ​

bookmarkPublicly(tag): Promise<Command>

Defined in: plugins/bookmarkLists.ts:28

Parameters ​

tag ​

string[]

Returns ​

Promise<Command>

fetch() ​

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

Defined in: plugins/bookmarkLists.ts:21

Parameters ​

pubkey ​

string

relayHints? ​

string[] = []

Returns ​

Promise<TrustedEvent | undefined>

Overrides ​

DerivedPlugin.fetch

get() ​

get(key): BookmarkListReader | undefined

Defined in: plugins/base.ts:190

Parameters ​

key ​

string

Returns ​

BookmarkListReader | undefined

Inherited from ​

DerivedPlugin.get

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

removeBookmark() ​

removeBookmark(value): Promise<Command>

Defined in: plugins/bookmarkLists.ts:32

Parameters ​

value ​

string

Returns ​

Promise<Command>

update() ​

update(fn): Promise<Command>

Defined in: plugins/bookmarkLists.ts:25

Parameters ​

fn ​

(writer) => void

Returns ​

Promise<Command>