Welshman Docs / @welshman/domain / AppDataReader

Class: AppDataReader

Defined in: kinds/AppData.ts:11

A reader that has to decrypt (or otherwise await something) before its accessors are complete. parse() returns a promise, so the type system makes callers await it rather than silently reading a half-parsed event.

Extends

• AsyncEventReader

Constructors

Constructor

new AppDataReader(kind, context, event): AppDataReader

Defined in: core/EventReader.ts:17

Parameters

kind

number

context

KindContext

event

TrustedEvent

Returns

AppDataReader

Inherited from

AsyncEventReader.constructor

Properties

context

readonly context: KindContext

Defined in: core/EventReader.ts:19

Inherited from

AsyncEventReader.context

---

decrypted

decrypted: boolean = false

Defined in: kinds/AppData.ts:12

---

encrypted

encrypted: boolean = false

Defined in: kinds/AppData.ts:13

---

event

readonly event: TrustedEvent

Defined in: core/EventReader.ts:20

Inherited from

AsyncEventReader.event

---

json

protected json: unknown = undefined

Defined in: kinds/AppData.ts:15

---

kind

readonly kind: number

Defined in: core/EventReader.ts:18

Inherited from

AsyncEventReader.kind

Methods

address()

address(): string

Defined in: core/EventReader.ts:55

Returns

string

Inherited from

AsyncEventReader.address

---

author()

author(): string

Defined in: core/EventReader.ts:35

Returns

string

Inherited from

AsyncEventReader.author

---

content()

content(): string

Defined in: core/EventReader.ts:39

Returns

string

Inherited from

AsyncEventReader.content

---

createdAt()

createdAt(): number

Defined in: core/EventReader.ts:47

Returns

number

Inherited from

AsyncEventReader.createdAt

---

emojis()

emojis(): Emoji[]

Defined in: core/EventReader.ts:71

Returns

Emoji[]

Inherited from

AsyncEventReader.emojis

---

expiration()

expiration(): undefined | number

Defined in: core/EventReader.ts:67

Returns

undefined | number

Inherited from

AsyncEventReader.expiration

---

id()

id(): string

Defined in: core/EventReader.ts:31

Returns

string

Inherited from

AsyncEventReader.id

---

identifier()

identifier(): undefined | string

Defined in: core/EventReader.ts:51

Returns

undefined | string

Inherited from

AsyncEventReader.identifier

---

parse()

parse(): Promise<AppDataReader>

Defined in: kinds/AppData.ts:17

Returns

Promise<AppDataReader>

Overrides

AsyncEventReader.parse

---

protect()

protect(): boolean

Defined in: core/EventReader.ts:63

Returns

boolean

Inherited from

AsyncEventReader.protect

---

room()

room(): undefined | string

Defined in: core/EventReader.ts:59

Returns

undefined | string

Inherited from

AsyncEventReader.room

---

tags()

tags(): string[][]

Defined in: core/EventReader.ts:43

Returns

string[][]

Inherited from

AsyncEventReader.tags

---

values()

values<T>(): undefined | T

Defined in: kinds/AppData.ts:49

Type Parameters

T

T

Returns

undefined | T

---

zapSplits()

zapSplits(): ZapSplit[]

Defined in: core/EventReader.ts:75

Returns

ZapSplit[]

Inherited from

AsyncEventReader.zapSplits