Welshman

Appearance

Welshman Docs / @welshman/domain / ListReader

Class: abstract ListReader ​

Defined in: core/ListReader.ts:5

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 ​

Extended by ​

Constructors ​

Constructor ​

new ListReader(kind, context, event): ListReader

Defined in: core/EventReader.ts:21

Parameters ​

kind ​

number

context ​

KindContext

event ​

TrustedEvent

Returns ​

ListReader

Inherited from ​

AsyncEventReader.constructor

Properties ​

context ​

readonly context: KindContext

Defined in: core/EventReader.ts:23

Inherited from ​

AsyncEventReader.context

decrypted ​

decrypted: boolean = false

Defined in: core/ListReader.ts:6

event ​

readonly event: TrustedEvent

Defined in: core/EventReader.ts:24

Inherited from ​

AsyncEventReader.event

kind ​

readonly kind: number

Defined in: core/EventReader.ts:22

Inherited from ​

AsyncEventReader.kind

privateTags ​

privateTags: string[][] = []

Defined in: core/ListReader.ts:8

publicTags ​

publicTags: string[][] = []

Defined in: core/ListReader.ts:7

Methods ​

address() ​

address(): string

Defined in: core/EventReader.ts:59

Returns ​

string

Inherited from ​

AsyncEventReader.address

author() ​

author(): string

Defined in: core/EventReader.ts:39

Returns ​

string

Inherited from ​

AsyncEventReader.author

client() ​

client(): undefined | Client

Defined in: core/EventReader.ts:83

Returns ​

undefined | Client

Inherited from ​

AsyncEventReader.client

content() ​

content(): string

Defined in: core/EventReader.ts:43

Returns ​

string

Inherited from ​

AsyncEventReader.content

contentWarning() ​

contentWarning(): boolean

Defined in: core/EventReader.ts:75

Returns ​

boolean

Inherited from ​

AsyncEventReader.contentWarning

contentWarningReason() ​

contentWarningReason(): undefined | string

Defined in: core/EventReader.ts:79

Returns ​

undefined | string

Inherited from ​

AsyncEventReader.contentWarningReason

createdAt() ​

createdAt(): number

Defined in: core/EventReader.ts:51

Returns ​

number

Inherited from ​

AsyncEventReader.createdAt

emojis() ​

emojis(): Emoji[]

Defined in: core/EventReader.ts:87

Returns ​

Emoji[]

Inherited from ​

AsyncEventReader.emojis

expiration() ​

expiration(): undefined | number

Defined in: core/EventReader.ts:71

Returns ​

undefined | number

Inherited from ​

AsyncEventReader.expiration

id() ​

id(): string

Defined in: core/EventReader.ts:35

Returns ​

string

Inherited from ​

AsyncEventReader.id

identifier() ​

identifier(): undefined | string

Defined in: core/EventReader.ts:55

Returns ​

undefined | string

Inherited from ​

AsyncEventReader.identifier

parse() ​

parse(): Promise<ListReader>

Defined in: core/ListReader.ts:10

Returns ​

Promise<ListReader>

Overrides ​

AsyncEventReader.parse

protect() ​

protect(): boolean

Defined in: core/EventReader.ts:67

Returns ​

boolean

Inherited from ​

AsyncEventReader.protect

room() ​

room(): undefined | string

Defined in: core/EventReader.ts:63

Returns ​

undefined | string

Inherited from ​

AsyncEventReader.room

tags() ​

tags(): string[][]

Defined in: core/ListReader.ts:38

Returns ​

string[][]

Overrides ​

AsyncEventReader.tags

zapSplits() ​

zapSplits(): ZapSplit[]

Defined in: core/EventReader.ts:91

Returns ​

ZapSplit[]

Inherited from ​

AsyncEventReader.zapSplits