Welshman

Appearance

Welshman Docs / @welshman/domain / BookmarkSetWriter

Class: BookmarkSetWriter ​

Defined in: domain/src/kinds/BookmarkSet.ts:22

Extends ​

Constructors ​

Constructor ​

new BookmarkSetWriter(kind, context, reader?): BookmarkSetWriter

Defined in: domain/src/core/ListWriter.ts:12

Parameters ​

kind ​

number

context ​

KindContext

reader? ​

BookmarkSetReader

Returns ​

BookmarkSetWriter

Inherited from ​

BookmarkListWriter.constructor

Properties ​

clientTag? ​

optional clientTag?: string[]

Defined in: domain/src/core/EventWriter.ts:57

Inherited from ​

BookmarkListWriter.clientTag

content ​

content: string = ""

Defined in: domain/src/core/EventWriter.ts:52

Inherited from ​

BookmarkListWriter.content

contentWarningTag? ​

optional contentWarningTag?: string[]

Defined in: domain/src/core/EventWriter.ts:56

Inherited from ​

BookmarkListWriter.contentWarningTag

context ​

readonly context: KindContext

Defined in: domain/src/core/EventWriter.ts:69

Inherited from ​

BookmarkListWriter.context

expirationTag? ​

optional expirationTag?: string[]

Defined in: domain/src/core/EventWriter.ts:55

Inherited from ​

BookmarkListWriter.expirationTag

extraTags ​

extraTags: string[][] = []

Defined in: domain/src/core/EventWriter.ts:59

Inherited from ​

BookmarkListWriter.extraTags

forcedRoutes? ​

optional forcedRoutes?: RelaySelection[]

Defined in: domain/src/core/EventWriter.ts:60

Inherited from ​

BookmarkListWriter.forcedRoutes

identifierTag? ​

optional identifierTag?: string[]

Defined in: domain/src/core/EventWriter.ts:58

Inherited from ​

BookmarkListWriter.identifierTag

kind ​

readonly kind: number

Defined in: domain/src/core/EventWriter.ts:68

Inherited from ​

BookmarkListWriter.kind

pendingResolves ​

pendingResolves: Promise<unknown>[] = []

Defined in: domain/src/core/EventWriter.ts:61

Inherited from ​

BookmarkListWriter.pendingResolves

privateTags ​

privateTags: string[][] = []

Defined in: domain/src/core/ListWriter.ts:10

Inherited from ​

BookmarkListWriter.privateTags

protectTag? ​

optional protectTag?: string[]

Defined in: domain/src/core/EventWriter.ts:54

Inherited from ​

BookmarkListWriter.protectTag

publicTags ​

publicTags: string[][] = []

Defined in: domain/src/core/ListWriter.ts:9

Inherited from ​

BookmarkListWriter.publicTags

reader? ​

readonly optional reader?: BookmarkSetReader

Defined in: domain/src/core/EventWriter.ts:70

Inherited from ​

BookmarkListWriter.reader

requiresRelays ​

readonly requiresRelays: boolean = false

Defined in: domain/src/core/EventWriter.ts:65

Inherited from ​

BookmarkListWriter.requiresRelays

roomTag? ​

optional roomTag?: string[]

Defined in: domain/src/core/EventWriter.ts:53

Inherited from ​

BookmarkListWriter.roomTag

Methods ​

addEmoji() ​

addEmoji(shortcode, url, address?): BookmarkSetWriter

Defined in: domain/src/core/EventWriter.ts:269

Parameters ​

shortcode ​

string

url ​

string

address? ​

string

Returns ​

BookmarkSetWriter

Inherited from ​

BookmarkListWriter.addEmoji

addImeta() ​

addImeta(imeta): BookmarkSetWriter

Defined in: domain/src/core/EventWriter.ts:261

Parameters ​

imeta ​

Imeta

Returns ​

BookmarkSetWriter

Inherited from ​

BookmarkListWriter.addImeta

addMention() ​

addMention(pubkey): BookmarkSetWriter

Defined in: domain/src/core/EventWriter.ts:209

Parameters ​

pubkey ​

string

Returns ​

BookmarkSetWriter

Inherited from ​

BookmarkListWriter.addMention

addPrivate() ​

addPrivate(...tags): BookmarkSetWriter

Defined in: domain/src/core/ListWriter.ts:28

Parameters ​

tags ​

...string[][]

Returns ​

BookmarkSetWriter

Inherited from ​

BookmarkListWriter.addPrivate

addPublic() ​

addPublic(...tags): BookmarkSetWriter

Defined in: domain/src/core/ListWriter.ts:22

Parameters ​

tags ​

...string[][]

Returns ​

BookmarkSetWriter

Inherited from ​

BookmarkListWriter.addPublic

addQuote() ​

addQuote(event): BookmarkSetWriter

Defined in: domain/src/core/EventWriter.ts:225

Parameters ​

event ​

TrustedEvent

Returns ​

BookmarkSetWriter

Inherited from ​

BookmarkListWriter.addQuote

addTags() ​

addTags(...tags): BookmarkSetWriter

Defined in: domain/src/core/EventWriter.ts:191

Parameters ​

tags ​

...string[][]

Returns ​

BookmarkSetWriter

Inherited from ​

BookmarkListWriter.addTags

addZapSplit() ​

addZapSplit(pubkey, split?): BookmarkSetWriter

Defined in: domain/src/core/EventWriter.ts:241

Parameters ​

pubkey ​

string

split? ​

number = 1

Returns ​

BookmarkSetWriter

Inherited from ​

BookmarkListWriter.addZapSplit

bookmarkPrivately() ​

bookmarkPrivately(tag): BookmarkSetWriter

Defined in: domain/src/kinds/BookmarkList.ts:42

Parameters ​

tag ​

string[]

Returns ​

BookmarkSetWriter

Inherited from ​

BookmarkListWriter.bookmarkPrivately

bookmarkPublicly() ​

bookmarkPublicly(tag): BookmarkSetWriter

Defined in: domain/src/kinds/BookmarkList.ts:38

Parameters ​

tag ​

string[]

Returns ​

BookmarkSetWriter

Inherited from ​

BookmarkListWriter.bookmarkPublicly

clearClient() ​

clearClient(): BookmarkSetWriter

Defined in: domain/src/core/EventWriter.ts:173

Returns ​

BookmarkSetWriter

Inherited from ​

BookmarkListWriter.clearClient

clearContentWarning() ​

clearContentWarning(): BookmarkSetWriter

Defined in: domain/src/core/EventWriter.ts:148

Returns ​

BookmarkSetWriter

Inherited from ​

BookmarkListWriter.clearContentWarning

clearExpiration() ​

clearExpiration(): BookmarkSetWriter

Defined in: domain/src/core/EventWriter.ts:135

Returns ​

BookmarkSetWriter

Inherited from ​

BookmarkListWriter.clearExpiration

clearForcedRoutes() ​

clearForcedRoutes(): BookmarkSetWriter

Defined in: domain/src/core/EventWriter.ts:117

Returns ​

BookmarkSetWriter

Inherited from ​

BookmarkListWriter.clearForcedRoutes

clearIdentifier() ​

clearIdentifier(): BookmarkSetWriter

Defined in: domain/src/core/EventWriter.ts:185

Returns ​

BookmarkSetWriter

Inherited from ​

BookmarkListWriter.clearIdentifier

clearRoom() ​

clearRoom(): BookmarkSetWriter

Defined in: domain/src/core/EventWriter.ts:99

Returns ​

BookmarkSetWriter

Inherited from ​

BookmarkListWriter.clearRoom

dropPrivate() ​

dropPrivate(pred): BookmarkSetWriter

Defined in: domain/src/core/ListWriter.ts:59

Parameters ​

pred ​

(tag) => unknown

Returns ​

BookmarkSetWriter

Inherited from ​

BookmarkListWriter.dropPrivate

dropPublic() ​

dropPublic(pred): BookmarkSetWriter

Defined in: domain/src/core/ListWriter.ts:53

Parameters ​

pred ​

(tag) => unknown

Returns ​

BookmarkSetWriter

Inherited from ​

BookmarkListWriter.dropPublic

dropTags() ​

dropTags(pred): BookmarkSetWriter

Defined in: domain/src/core/ListWriter.ts:65

Parameters ​

pred ​

(tag) => unknown

Returns ​

BookmarkSetWriter

Inherited from ​

BookmarkListWriter.dropTags

forceRoutes() ​

forceRoutes(...routes): BookmarkSetWriter

Defined in: domain/src/core/EventWriter.ts:111

Replaces the rendered routes. These are routes rather than urls, so forceRoutes(userInbox()) pins an event to the user's read relays without resolving them first.

Parameters ​

routes ​

...RelaySelection[]

Returns ​

BookmarkSetWriter

Inherited from ​

BookmarkListWriter.forceRoutes

hint() ​

protected hint(...routes): Promise<string>

Defined in: domain/src/core/EventWriter.ts:316

Resolves one or more relay selections to a single hint url, tracking the in-flight promise so renderTags can wait for it. Callers backfill the resolved url into a tag's hint slot.

Parameters ​

routes ​

...RelaySelection[]

Returns ​

Promise<string>

Inherited from ​

BookmarkListWriter.hint

imeta() ​

imeta(): Imeta[]

Defined in: domain/src/core/EventWriter.ts:257

Returns ​

Imeta[]

Inherited from ​

BookmarkListWriter.imeta

keepPrivate() ​

keepPrivate(pred): BookmarkSetWriter

Defined in: domain/src/core/ListWriter.ts:40

Parameters ​

pred ​

(tag) => unknown

Returns ​

BookmarkSetWriter

Inherited from ​

BookmarkListWriter.keepPrivate

keepPublic() ​

keepPublic(pred): BookmarkSetWriter

Defined in: domain/src/core/ListWriter.ts:34

Parameters ​

pred ​

(tag) => unknown

Returns ​

BookmarkSetWriter

Inherited from ​

BookmarkListWriter.keepPublic

keepTags() ​

keepTags(pred): BookmarkSetWriter

Defined in: domain/src/core/ListWriter.ts:46

Parameters ​

pred ​

(tag) => unknown

Returns ​

BookmarkSetWriter

Inherited from ​

BookmarkListWriter.keepTags

quotes() ​

quotes(): Quote[]

Defined in: domain/src/core/EventWriter.ts:221

Returns ​

Quote[]

Inherited from ​

BookmarkListWriter.quotes

relays() ​

relays(): Promise<string[]>

Defined in: domain/src/core/EventWriter.ts:400

Shortcut for getting relays from the router scenario. Forced routes bypass scoring.

Returns ​

Promise<string[]>

Inherited from ​

BookmarkListWriter.relays

removeBookmark() ​

removeBookmark(value): BookmarkSetWriter

Defined in: domain/src/kinds/BookmarkList.ts:46

Parameters ​

value ​

string

Returns ​

BookmarkSetWriter

Inherited from ​

BookmarkListWriter.removeBookmark

removeEmoji() ​

removeEmoji(shortcode): BookmarkSetWriter

Defined in: domain/src/core/EventWriter.ts:275

Parameters ​

shortcode ​

string

Returns ​

BookmarkSetWriter

Inherited from ​

BookmarkListWriter.removeEmoji

removeImeta() ​

removeImeta(match): BookmarkSetWriter

Defined in: domain/src/core/EventWriter.ts:265

Parameters ​

match ​

(imeta) => boolean

Returns ​

BookmarkSetWriter

Inherited from ​

BookmarkListWriter.removeImeta

removeQuote() ​

removeQuote(value): BookmarkSetWriter

Defined in: domain/src/core/EventWriter.ts:237

Parameters ​

value ​

string

Returns ​

BookmarkSetWriter

Inherited from ​

BookmarkListWriter.removeQuote

removeZapSplit() ​

removeZapSplit(pubkey): BookmarkSetWriter

Defined in: domain/src/core/EventWriter.ts:253

Parameters ​

pubkey ​

string

Returns ​

BookmarkSetWriter

Inherited from ​

BookmarkListWriter.removeZapSplit

render() ​

render(): Promise<{ event: EventTemplate; relays: string[]; }>

Defined in: domain/src/core/EventWriter.ts:409

Returns a rendered event template along with its relays.

Returns ​

Promise<{ event: EventTemplate; relays: string[]; }>

Inherited from ​

BookmarkListWriter.render

renderBehaviorTags() ​

protected renderBehaviorTags(): MaybeAsync<string[][]>

Defined in: domain/src/core/EventWriter.ts:323

Returns a list of tags that may be attached to any kind.

Returns ​

MaybeAsync<string[][]>

Inherited from ​

BookmarkListWriter.renderBehaviorTags

renderContent() ​

renderContent(): Promise<string>

Defined in: domain/src/core/ListWriter.ts:88

Returns the content string as defined by the kind.

Returns ​

Promise<string>

Inherited from ​

BookmarkListWriter.renderContent

renderDomainTags() ​

protected renderDomainTags(): string[][]

Defined in: domain/src/core/ListWriter.ts:84

Returns a list of tags related to the kind.

Returns ​

string[][]

Inherited from ​

BookmarkListWriter.renderDomainTags

renderRoutes() ​

protected renderRoutes(): Promise<RelaySelection[]>

Defined in: domain/src/core/EventWriter.ts:378

Returns the list of routes this event should be published to. Defaults to the outbox model. Override to implement custom behavior.

Returns ​

Promise<RelaySelection[]>

Inherited from ​

BookmarkListWriter.renderRoutes

renderTags() ​

renderTags(): Promise<string[][]>

Defined in: domain/src/core/EventWriter.ts:344

Returns the complete tag list for publishing.

Returns ​

Promise<string[][]>

Inherited from ​

BookmarkListWriter.renderTags

renderTemplate() ​

renderTemplate(): Promise<EventTemplate>

Defined in: domain/src/core/EventWriter.ts:364

Validates and renders an event template.

Returns ​

Promise<EventTemplate>

Inherited from ​

BookmarkListWriter.renderTemplate

scenario() ​

scenario(): Promise<RelayScenario>

Defined in: domain/src/core/EventWriter.ts:391

Returns a router scenario for this event. Publishes to the forced routes (e.g. a NIP-29 room's relay) when set, otherwise to the rendered routes.

The resolver's default limit is tuned for reads, where an extra relay is a round trip returning mostly the same events. Publishing is the opposite: a relay that never received the event serves it to nobody. Override scenario for a different limit.

Returns ​

Promise<RelayScenario>

Inherited from ​

BookmarkListWriter.scenario

setClient() ​

setClient(name, address?): BookmarkSetWriter

Defined in: domain/src/core/EventWriter.ts:159

Attributes the event to the NIP-89 client that produced it. address is an optional 31990:pubkey:d-tag pointer to the client's handler information event; when given, its author's outbox fills in the tag's relay hint slot.

Parameters ​

name ​

string

address? ​

string

Returns ​

BookmarkSetWriter

Inherited from ​

BookmarkListWriter.setClient

setContent() ​

setContent(content): BookmarkSetWriter

Defined in: domain/src/core/EventWriter.ts:86

Parameters ​

content ​

string

Returns ​

BookmarkSetWriter

Inherited from ​

BookmarkListWriter.setContent

setContentWarning() ​

setContentWarning(reason?): BookmarkSetWriter

Defined in: domain/src/core/EventWriter.ts:142

Parameters ​

reason? ​

string

Returns ​

BookmarkSetWriter

Inherited from ​

BookmarkListWriter.setContentWarning

setDescription() ​

setDescription(description): BookmarkSetWriter

Defined in: domain/src/kinds/BookmarkSet.ts:27

Parameters ​

description ​

string

Returns ​

BookmarkSetWriter

setExpiration() ​

setExpiration(expiration): BookmarkSetWriter

Defined in: domain/src/core/EventWriter.ts:129

Parameters ​

expiration ​

number

Returns ​

BookmarkSetWriter

Inherited from ​

BookmarkListWriter.setExpiration

setIdentifier() ​

setIdentifier(identifier?): BookmarkSetWriter

Defined in: domain/src/core/EventWriter.ts:179

Parameters ​

identifier? ​

string = ...

Returns ​

BookmarkSetWriter

Inherited from ​

BookmarkListWriter.setIdentifier

setImage() ​

setImage(image): BookmarkSetWriter

Defined in: domain/src/kinds/BookmarkSet.ts:31

Parameters ​

image ​

string

Returns ​

BookmarkSetWriter

setProtected() ​

setProtected(protect): BookmarkSetWriter

Defined in: domain/src/core/EventWriter.ts:123

Parameters ​

protect ​

Maybe<boolean>

Returns ​

BookmarkSetWriter

Inherited from ​

BookmarkListWriter.setProtected

setRoom() ​

setRoom(url, room): BookmarkSetWriter

Defined in: domain/src/core/EventWriter.ts:92

Parameters ​

url ​

string

room ​

string

Returns ​

BookmarkSetWriter

Inherited from ​

BookmarkListWriter.setRoom

setTitle() ​

setTitle(title): BookmarkSetWriter

Defined in: domain/src/kinds/BookmarkSet.ts:23

Parameters ​

title ​

string

Returns ​

BookmarkSetWriter

validate() ​

validate(): void

Defined in: domain/src/core/ListWriter.ts:72

Validates a domain object, throwing an error if invalid.

Returns ​

void

Inherited from ​

BookmarkListWriter.validate