Welshman Docs / @welshman/domain / BaseEventReader

Class: abstract BaseEventReader

Defined in: core/EventReader.ts:20

The accessors every reader shares. Readers don't extend this directly — they pick a branch below according to whether parsing their event can hit IO, which is what tells a caller whether parse() has to be awaited.

Extended by

• EventReader
• AsyncEventReader

Constructors

Constructor

new BaseEventReader(kind, context, event): BaseEventReader

Defined in: core/EventReader.ts:21

Parameters

kind

number

context

KindContext

event

TrustedEvent

Returns

BaseEventReader

Properties

context

readonly context: KindContext

Defined in: core/EventReader.ts:23

---

event

readonly event: TrustedEvent

Defined in: core/EventReader.ts:24

---

kind

readonly kind: number

Defined in: core/EventReader.ts:22

Methods

address()

address(): string

Defined in: core/EventReader.ts:59

Returns

string

---

author()

author(): string

Defined in: core/EventReader.ts:39

Returns

string

---

client()

client(): undefined | Client

Defined in: core/EventReader.ts:83

Returns

undefined | Client

---

content()

content(): string

Defined in: core/EventReader.ts:43

Returns

string

---

contentWarning()

contentWarning(): boolean

Defined in: core/EventReader.ts:75

Returns

boolean

---

contentWarningReason()

contentWarningReason(): undefined | string

Defined in: core/EventReader.ts:79

Returns

undefined | string

---

createdAt()

createdAt(): number

Defined in: core/EventReader.ts:51

Returns

number

---

emojis()

emojis(): Emoji[]

Defined in: core/EventReader.ts:87

Returns

Emoji[]

---

expiration()

expiration(): undefined | number

Defined in: core/EventReader.ts:71

Returns

undefined | number

---

id()

id(): string

Defined in: core/EventReader.ts:35

Returns

string

---

identifier()

identifier(): undefined | string

Defined in: core/EventReader.ts:55

Returns

undefined | string

---

parse()

abstract parse(): MaybeAsync<BaseEventReader>

Defined in: core/EventReader.ts:33

Returns

MaybeAsync<BaseEventReader>

---

protect()

protect(): boolean

Defined in: core/EventReader.ts:67

Returns

boolean

---

room()

room(): undefined | string

Defined in: core/EventReader.ts:63

Returns

undefined | string

---

tags()

tags(): string[][]

Defined in: core/EventReader.ts:47

Returns

string[][]

---

zapSplits()

zapSplits(): ZapSplit[]

Defined in: core/EventReader.ts:91

Returns

ZapSplit[]