Welshman

Appearance

Welshman Docs / @welshman/domain / PollReader

Class: PollReader ​

Defined in: kinds/Poll.ts:21

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: core/EventReader.ts:17

Parameters ​

kind ​

number

context ​

KindContext

event ​

TrustedEvent

Returns ​

PollReader

Inherited from ​

EventReader.constructor

Properties ​

context ​

readonly context: KindContext

Defined in: core/EventReader.ts:19

Inherited from ​

EventReader.context

event ​

readonly event: TrustedEvent

Defined in: core/EventReader.ts:20

Inherited from ​

EventReader.event

kind ​

readonly kind: number

Defined in: core/EventReader.ts:18

Inherited from ​

EventReader.kind

Methods ​

address() ​

address(): string

Defined in: core/EventReader.ts:55

Returns ​

string

Inherited from ​

EventReader.address

author() ​

author(): string

Defined in: core/EventReader.ts:35

Returns ​

string

Inherited from ​

EventReader.author

content() ​

content(): string

Defined in: core/EventReader.ts:39

Returns ​

string

Inherited from ​

EventReader.content

createdAt() ​

createdAt(): number

Defined in: core/EventReader.ts:47

Returns ​

number

Inherited from ​

EventReader.createdAt

emojis() ​

emojis(): Emoji[]

Defined in: core/EventReader.ts:71

Returns ​

Emoji[]

Inherited from ​

EventReader.emojis

endsAt() ​

endsAt(): undefined | number

Defined in: kinds/Poll.ts:34

Returns ​

undefined | number

expiration() ​

expiration(): undefined | number

Defined in: core/EventReader.ts:67

Returns ​

undefined | number

Inherited from ​

EventReader.expiration

id() ​

id(): string

Defined in: core/EventReader.ts:31

Returns ​

string

Inherited from ​

EventReader.id

identifier() ​

identifier(): undefined | string

Defined in: core/EventReader.ts:51

Returns ​

undefined | string

Inherited from ​

EventReader.identifier

isClosed() ​

isClosed(): boolean

Defined in: kinds/Poll.ts:40

Returns ​

boolean

options() ​

options(): PollOption[]

Defined in: kinds/Poll.ts:26

Returns ​

PollOption[]

parse() ​

parse(): this

Defined in: core/EventReader.ts:86

Returns ​

this

Inherited from ​

EventReader.parse

pollType() ​

pollType(): PollType

Defined in: kinds/Poll.ts:30

Returns ​

PollType

protect() ​

protect(): boolean

Defined in: core/EventReader.ts:63

Returns ​

boolean

Inherited from ​

EventReader.protect

results() ​

results(responses): PollResult

Defined in: kinds/Poll.ts:50

Parameters ​

responses ​

TrustedEvent[]

Returns ​

PollResult

room() ​

room(): undefined | string

Defined in: core/EventReader.ts:59

Returns ​

undefined | string

Inherited from ​

EventReader.room

tags() ​

tags(): string[][]

Defined in: core/EventReader.ts:43

Returns ​

string[][]

Inherited from ​

EventReader.tags

title() ​

title(): string

Defined in: kinds/Poll.ts:22

Returns ​

string

urls() ​

urls(): string[]

Defined in: kinds/Poll.ts:46

Returns ​

string[]

zapSplits() ​

zapSplits(): ZapSplit[]

Defined in: core/EventReader.ts:75

Returns ​

ZapSplit[]

Inherited from ​

EventReader.zapSplits