Welshman

Appearance

Welshman Docs / @welshman/domain / BaseEventReader

Class: abstract BaseEventReader ​

Defined in: core/EventReader.ts:16

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 ​

Constructors ​

Constructor ​

new BaseEventReader(kind, context, event): BaseEventReader

Defined in: core/EventReader.ts:17

Parameters ​

kind ​

number

context ​

KindContext

event ​

TrustedEvent

Returns ​

BaseEventReader

Properties ​

context ​

readonly context: KindContext

Defined in: core/EventReader.ts:19

event ​

readonly event: TrustedEvent

Defined in: core/EventReader.ts:20

kind ​

readonly kind: number

Defined in: core/EventReader.ts:18

Methods ​

address() ​

address(): string

Defined in: core/EventReader.ts:55

Returns ​

string

author() ​

author(): string

Defined in: core/EventReader.ts:35

Returns ​

string

content() ​

content(): string

Defined in: core/EventReader.ts:39

Returns ​

string

createdAt() ​

createdAt(): number

Defined in: core/EventReader.ts:47

Returns ​

number

emojis() ​

emojis(): Emoji[]

Defined in: core/EventReader.ts:71

Returns ​

Emoji[]

expiration() ​

expiration(): undefined | number

Defined in: core/EventReader.ts:67

Returns ​

undefined | number

id() ​

id(): string

Defined in: core/EventReader.ts:31

Returns ​

string

identifier() ​

identifier(): undefined | string

Defined in: core/EventReader.ts:51

Returns ​

undefined | string

parse() ​

abstract parse(): MaybeAsync<BaseEventReader>

Defined in: core/EventReader.ts:29

Returns ​

MaybeAsync<BaseEventReader>

protect() ​

protect(): boolean

Defined in: core/EventReader.ts:63

Returns ​

boolean

room() ​

room(): undefined | string

Defined in: core/EventReader.ts:59

Returns ​

undefined | string

tags() ​

tags(): string[][]

Defined in: core/EventReader.ts:43

Returns ​

string[][]

zapSplits() ​

zapSplits(): ZapSplit[]

Defined in: core/EventReader.ts:75

Returns ​

ZapSplit[]