Welshman Docs / @welshman/domain / RoomListWriter

Class: RoomListWriter

Defined in: kinds/RoomList.ts:59

Extends

• ListWriter<RoomListReader>

Constructors

Constructor

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

Defined in: core/ListWriter.ts:12

Parameters

kind

number

context

KindContext

reader?

RoomListReader

Returns

RoomListWriter

Inherited from

ListWriter.constructor

Properties

content

content: string = ""

Defined in: core/EventWriter.ts:37

Inherited from

ListWriter.content

---

context

readonly context: KindContext

Defined in: core/EventWriter.ts:52

Inherited from

ListWriter.context

---

expirationTag?

optional expirationTag: string[]

Defined in: core/EventWriter.ts:40

Inherited from

ListWriter.expirationTag

---

extraTags

extraTags: string[][] = []

Defined in: core/EventWriter.ts:42

Inherited from

ListWriter.extraTags

---

forcedRelays?

optional forcedRelays: string[]

Defined in: core/EventWriter.ts:43

Inherited from

ListWriter.forcedRelays

---

identifierTag?

optional identifierTag: string[]

Defined in: core/EventWriter.ts:41

Inherited from

ListWriter.identifierTag

---

kind

readonly kind: number

Defined in: core/EventWriter.ts:51

Inherited from

ListWriter.kind

---

pendingResolves

pendingResolves: Promise<unknown>[] = []

Defined in: core/EventWriter.ts:44

Inherited from

ListWriter.pendingResolves

---

privateTags

privateTags: string[][] = []

Defined in: core/ListWriter.ts:10

Inherited from

ListWriter.privateTags

---

protectTag?

optional protectTag: string[]

Defined in: core/EventWriter.ts:39

Inherited from

ListWriter.protectTag

---

publicTags

publicTags: string[][] = []

Defined in: core/ListWriter.ts:9

Inherited from

ListWriter.publicTags

---

reader?

readonly optional reader: RoomListReader

Defined in: core/EventWriter.ts:53

Inherited from

ListWriter.reader

---

requiresRelays

readonly requiresRelays: boolean = false

Defined in: core/EventWriter.ts:48

Inherited from

ListWriter.requiresRelays

---

roomTag?

optional roomTag: string[]

Defined in: core/EventWriter.ts:38

Inherited from

ListWriter.roomTag

Methods

addEmoji()

addEmoji(shortcode, url, address?): RoomListWriter

Defined in: core/EventWriter.ts:187

Parameters

shortcode

string

url

string

address?

string

Returns

RoomListWriter

Inherited from

ListWriter.addEmoji

---

addMention()

addMention(pubkey): RoomListWriter

Defined in: core/EventWriter.ts:147

Parameters

pubkey

string

Returns

RoomListWriter

Inherited from

ListWriter.addMention

---

addPrivate()

addPrivate(...tags): RoomListWriter

Defined in: core/ListWriter.ts:28

Parameters

tags

...string[][]

Returns

RoomListWriter

Inherited from

ListWriter.addPrivate

---

addPublic()

addPublic(...tags): RoomListWriter

Defined in: core/ListWriter.ts:22

Parameters

tags

...string[][]

Returns

RoomListWriter

Inherited from

ListWriter.addPublic

---

addQuote()

addQuote(event): RoomListWriter

Defined in: core/EventWriter.ts:159

Parameters

event

TrustedEvent

Returns

RoomListWriter

Inherited from

ListWriter.addQuote

---

addRelay()

addRelay(url): RoomListWriter

Defined in: kinds/RoomList.ts:85

Parameters

url

string

Returns

RoomListWriter

---

addRoom()

addRoom(roomId, url): RoomListWriter

Defined in: kinds/RoomList.ts:70

Parameters

roomId

string

url

string

Returns

RoomListWriter

---

addTags()

addTags(...tags): RoomListWriter

Defined in: core/EventWriter.ts:129

Parameters

tags

...string[][]

Returns

RoomListWriter

Inherited from

ListWriter.addTags

---

addZapSplit()

addZapSplit(pubkey, split): RoomListWriter

Defined in: core/EventWriter.ts:171

Parameters

pubkey

string

split

number = 1

Returns

RoomListWriter

Inherited from

ListWriter.addZapSplit

---

clearExpiration()

clearExpiration(): RoomListWriter

Defined in: core/EventWriter.ts:111

Returns

RoomListWriter

Inherited from

ListWriter.clearExpiration

---

clearForcedRelays()

clearForcedRelays(): RoomListWriter

Defined in: core/EventWriter.ts:93

Returns

RoomListWriter

Inherited from

ListWriter.clearForcedRelays

---

clearIdentifier()

clearIdentifier(): RoomListWriter

Defined in: core/EventWriter.ts:123

Returns

RoomListWriter

Inherited from

ListWriter.clearIdentifier

---

clearRoom()

clearRoom(): RoomListWriter

Defined in: core/EventWriter.ts:80

Returns

RoomListWriter

Inherited from

ListWriter.clearRoom

---

dropPrivate()

dropPrivate(pred): RoomListWriter

Defined in: core/ListWriter.ts:59

Parameters

pred

(tag) => boolean

Returns

RoomListWriter

Inherited from

ListWriter.dropPrivate

---

dropPublic()

dropPublic(pred): RoomListWriter

Defined in: core/ListWriter.ts:53

Parameters

pred

(tag) => boolean

Returns

RoomListWriter

Inherited from

ListWriter.dropPublic

---

dropTags()

dropTags(pred): RoomListWriter

Defined in: core/ListWriter.ts:65

Parameters

pred

(tag) => boolean

Returns

RoomListWriter

Inherited from

ListWriter.dropTags

---

forceRelays()

forceRelays(...urls): RoomListWriter

Defined in: core/EventWriter.ts:87

Parameters

urls

...string[]

Returns

RoomListWriter

Inherited from

ListWriter.forceRelays

---

hint()

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

Defined in: core/EventWriter.ts:234

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

ListWriter.hint

---

keepPrivate()

keepPrivate(pred): RoomListWriter

Defined in: core/ListWriter.ts:40

Parameters

pred

(tag) => boolean

Returns

RoomListWriter

Inherited from

ListWriter.keepPrivate

---

keepPublic()

keepPublic(pred): RoomListWriter

Defined in: core/ListWriter.ts:34

Parameters

pred

(tag) => boolean

Returns

RoomListWriter

Inherited from

ListWriter.keepPublic

---

keepTags()

keepTags(pred): RoomListWriter

Defined in: core/ListWriter.ts:46

Parameters

pred

(tag) => boolean

Returns

RoomListWriter

Inherited from

ListWriter.keepTags

---

migrateRelay()

migrateRelay(oldUrl, newUrl): RoomListWriter

Defined in: kinds/RoomList.ts:122

Parameters

oldUrl

string

newUrl

string

Returns

RoomListWriter

---

relays()

relays(): Promise<string[]>

Defined in: core/EventWriter.ts:306

Shortcut for getting relays from the router scenario.

Returns

Promise<string[]>

Inherited from

ListWriter.relays

---

removeEmoji()

removeEmoji(shortcode): RoomListWriter

Defined in: core/EventWriter.ts:193

Parameters

shortcode

string

Returns

RoomListWriter

Inherited from

ListWriter.removeEmoji

---

removeRelay()

removeRelay(url): RoomListWriter

Defined in: kinds/RoomList.ts:96

Parameters

url

string

Returns

RoomListWriter

---

removeRoom()

removeRoom(roomId, url?): RoomListWriter

Defined in: kinds/RoomList.ts:74

Parameters

roomId

string

url?

string

Returns

RoomListWriter

---

removeZapSplit()

removeZapSplit(pubkey): RoomListWriter

Defined in: core/EventWriter.ts:183

Parameters

pubkey

string

Returns

RoomListWriter

Inherited from

ListWriter.removeZapSplit

---

render()

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

Defined in: core/EventWriter.ts:313

Returns a rendered event template along with its relays.

Returns

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

Inherited from

ListWriter.render

---

renderBehaviorTags()

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

Defined in: core/EventWriter.ts:241

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

Returns

MaybeAsync<string[][]>

Inherited from

ListWriter.renderBehaviorTags

---

renderContent()

renderContent(): Promise<string>

Defined in: core/ListWriter.ts:86

Returns the content string as defined by the kind.

Returns

Promise<string>

Inherited from

ListWriter.renderContent

---

renderDomainTags()

protected renderDomainTags(): string[][]

Defined in: core/ListWriter.ts:82

Returns a list of tags related to the kind.

Returns

string[][]

Inherited from

ListWriter.renderDomainTags

---

renderRoutes()

protected renderRoutes(): Promise<RelaySelection[]>

Defined in: kinds/RoomList.ts:63

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

Returns

Promise<RelaySelection[]>

Overrides

ListWriter.renderRoutes

---

renderTags()

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

Defined in: core/EventWriter.ts:255

Returns the complete tag list for publishing.

Returns

Promise<string[][]>

Inherited from

ListWriter.renderTags

---

renderTemplate()

renderTemplate(): Promise<EventTemplate>

Defined in: core/EventWriter.ts:275

Validates and renders an event template.

Returns

Promise<EventTemplate>

Inherited from

ListWriter.renderTemplate

---

scenario()

scenario(): Promise<RelayScenario>

Defined in: core/EventWriter.ts:297

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

Returns

Promise<RelayScenario>

Inherited from

ListWriter.scenario

---

setContent()

setContent(content): RoomListWriter

Defined in: core/EventWriter.ts:67

Parameters

content

string

Returns

RoomListWriter

Inherited from

ListWriter.setContent

---

setExpiration()

setExpiration(expiration): RoomListWriter

Defined in: core/EventWriter.ts:105

Parameters

expiration

number

Returns

RoomListWriter

Inherited from

ListWriter.setExpiration

---

setIdentifier()

setIdentifier(identifier): RoomListWriter

Defined in: core/EventWriter.ts:117

Parameters

identifier

string = ...

Returns

RoomListWriter

Inherited from

ListWriter.setIdentifier

---

setProtected()

setProtected(protect): RoomListWriter

Defined in: core/EventWriter.ts:99

Parameters

protect

boolean

Returns

RoomListWriter

Inherited from

ListWriter.setProtected

---

setRelays()

setRelays(urls): RoomListWriter

Defined in: kinds/RoomList.ts:108

Parameters

urls

string[]

Returns

RoomListWriter

---

setRoom()

setRoom(url, room): RoomListWriter

Defined in: core/EventWriter.ts:73

Parameters

url

string

room

string

Returns

RoomListWriter

Inherited from

ListWriter.setRoom

---

validate()

validate(): void

Defined in: core/ListWriter.ts:72

Validates a domain object, throwing an error if invalid.

Returns

void

Inherited from

ListWriter.validate