Welshman

Appearance

Welshman Docs / @welshman/domain / PollReader

Class: PollReader ​

Defined in: domain/src/kinds/Poll.ts:22

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 PollReader(kind, context, event): PollReader

Defined in: domain/src/core/EventReader.ts:25

Parameters ​

kind ​

number

context ​

KindContext

event ​

TrustedEvent

Returns ​

PollReader

Inherited from ​

EventReader.constructor

Properties ​

context ​

readonly context: KindContext

Defined in: domain/src/core/EventReader.ts:27

Inherited from ​

EventReader.context

event ​

readonly event: TrustedEvent

Defined in: domain/src/core/EventReader.ts:28

Inherited from ​

EventReader.event

kind ​

readonly kind: number

Defined in: domain/src/core/EventReader.ts:26

Inherited from ​

EventReader.kind

Methods ​

address() ​

address(): string

Defined in: domain/src/core/EventReader.ts:63

Returns ​

string

Inherited from ​

EventReader.address

author() ​

author(): string

Defined in: domain/src/core/EventReader.ts:43

Returns ​

string

Inherited from ​

EventReader.author

client() ​

client(): Client | undefined

Defined in: domain/src/core/EventReader.ts:87

Returns ​

Client | undefined

Inherited from ​

EventReader.client

content() ​

content(): string

Defined in: domain/src/core/EventReader.ts:47

Returns ​

string

Inherited from ​

EventReader.content

contentWarning() ​

contentWarning(): boolean

Defined in: domain/src/core/EventReader.ts:79

Returns ​

boolean

Inherited from ​

EventReader.contentWarning

contentWarningReason() ​

contentWarningReason(): string | undefined

Defined in: domain/src/core/EventReader.ts:83

Returns ​

string | undefined

Inherited from ​

EventReader.contentWarningReason

createdAt() ​

createdAt(): number

Defined in: domain/src/core/EventReader.ts:55

Returns ​

number

Inherited from ​

EventReader.createdAt

emojis() ​

emojis(): Emoji[]

Defined in: domain/src/core/EventReader.ts:91

Returns ​

Emoji[]

Inherited from ​

EventReader.emojis

endsAt() ​

endsAt(): number | undefined

Defined in: domain/src/kinds/Poll.ts:35

Returns ​

number | undefined

expiration() ​

expiration(): number | undefined

Defined in: domain/src/core/EventReader.ts:75

Returns ​

number | undefined

Inherited from ​

EventReader.expiration

id() ​

id(): string

Defined in: domain/src/core/EventReader.ts:39

Returns ​

string

Inherited from ​

EventReader.id

identifier() ​

identifier(): string | undefined

Defined in: domain/src/core/EventReader.ts:59

Returns ​

string | undefined

Inherited from ​

EventReader.identifier

imeta() ​

imeta(): Imeta[]

Defined in: domain/src/core/EventReader.ts:95

Returns ​

Imeta[]

Inherited from ​

EventReader.imeta

isClosed() ​

isClosed(): boolean

Defined in: domain/src/kinds/Poll.ts:41

Returns ​

boolean

options() ​

options(): PollOption[]

Defined in: domain/src/kinds/Poll.ts:27

Returns ​

PollOption[]

parse() ​

parse(): this

Defined in: domain/src/core/EventReader.ts:114

Returns ​

this

Inherited from ​

EventReader.parse

pollType() ​

pollType(): PollType

Defined in: domain/src/kinds/Poll.ts:31

Returns ​

PollType

protect() ​

protect(): boolean

Defined in: domain/src/core/EventReader.ts:71

Returns ​

boolean

Inherited from ​

EventReader.protect

quotes() ​

quotes(): Quote[]

Defined in: domain/src/core/EventReader.ts:99

Returns ​

Quote[]

Inherited from ​

EventReader.quotes

results() ​

results(responses): PollResult

Defined in: domain/src/kinds/Poll.ts:51

Parameters ​

responses ​

TrustedEvent[]

Returns ​

PollResult

room() ​

room(): string | undefined

Defined in: domain/src/core/EventReader.ts:67

Returns ​

string | undefined

Inherited from ​

EventReader.room

tags() ​

tags(): string[][]

Defined in: domain/src/core/EventReader.ts:51

Returns ​

string[][]

Inherited from ​

EventReader.tags

title() ​

title(): string

Defined in: domain/src/kinds/Poll.ts:23

Returns ​

string

urls() ​

urls(): string[]

Defined in: domain/src/kinds/Poll.ts:47

Returns ​

string[]

zapSplits() ​

zapSplits(): ZapSplit[]

Defined in: domain/src/core/EventReader.ts:103

Returns ​

ZapSplit[]

Inherited from ​

EventReader.zapSplits