Skip to content

Welshman Docs / @welshman/domain / RoomMetaReader

Class: RoomMetaReader

Defined in: kinds/RoomMeta.ts:8

A reader whose event can be parsed without IO — the common case. parse() returns the reader itself, so callers never await it. Override parse to derive state from the event, returning this.

Extends

Constructors

Constructor

new RoomMetaReader(kind, context, event): RoomMetaReader

Defined in: core/EventReader.ts:17

Parameters

kind

number

context

KindContext

event

TrustedEvent

Returns

RoomMetaReader

Inherited from

EventReader.constructor

Properties

context

readonly context: KindContext

Defined in: core/EventReader.ts:19

Inherited from

EventReader.context


event

readonly event: TrustedEvent

Defined in: core/EventReader.ts:20

Inherited from

EventReader.event


kind

readonly kind: number

Defined in: core/EventReader.ts:18

Inherited from

EventReader.kind

Methods

about()

about(): undefined | string

Defined in: kinds/RoomMeta.ts:13

Returns

undefined | string


address()

address(): string

Defined in: core/EventReader.ts:55

Returns

string

Inherited from

EventReader.address


author()

author(): string

Defined in: core/EventReader.ts:35

Returns

string

Inherited from

EventReader.author


content()

content(): string

Defined in: core/EventReader.ts:39

Returns

string

Inherited from

EventReader.content


createdAt()

createdAt(): number

Defined in: core/EventReader.ts:47

Returns

number

Inherited from

EventReader.createdAt


emojis()

emojis(): Emoji[]

Defined in: core/EventReader.ts:71

Returns

Emoji[]

Inherited from

EventReader.emojis


expiration()

expiration(): undefined | number

Defined in: core/EventReader.ts:67

Returns

undefined | number

Inherited from

EventReader.expiration


hasLivekit()

hasLivekit(): boolean

Defined in: kinds/RoomMeta.ts:43

Returns

boolean


id()

id(): string

Defined in: core/EventReader.ts:31

Returns

string

Inherited from

EventReader.id


identifier()

identifier(): undefined | string

Defined in: core/EventReader.ts:51

Returns

undefined | string

Inherited from

EventReader.identifier


isClosed()

isClosed(): boolean

Defined in: kinds/RoomMeta.ts:27

Returns

boolean


isHidden()

isHidden(): boolean

Defined in: kinds/RoomMeta.ts:31

Returns

boolean


isPrivate()

isPrivate(): boolean

Defined in: kinds/RoomMeta.ts:35

Returns

boolean


isRestricted()

isRestricted(): boolean

Defined in: kinds/RoomMeta.ts:39

Returns

boolean


name()

name(): undefined | string

Defined in: kinds/RoomMeta.ts:9

Returns

undefined | string


parse()

parse(): this

Defined in: core/EventReader.ts:86

Returns

this

Inherited from

EventReader.parse


picture()

picture(): undefined | string

Defined in: kinds/RoomMeta.ts:17

Returns

undefined | string


pictureMeta()

pictureMeta(): undefined | string[]

Defined in: kinds/RoomMeta.ts:21

Returns

undefined | string[]


protect()

protect(): boolean

Defined in: core/EventReader.ts:63

Returns

boolean

Inherited from

EventReader.protect


room()

room(): undefined | string

Defined in: core/EventReader.ts:59

Returns

undefined | string

Inherited from

EventReader.room


tags()

tags(): string[][]

Defined in: core/EventReader.ts:43

Returns

string[][]

Inherited from

EventReader.tags


zapSplits()

zapSplits(): ZapSplit[]

Defined in: core/EventReader.ts:75

Returns

ZapSplit[]

Inherited from

EventReader.zapSplits