Welshman Docs / @welshman/domain / PinboardReader

Class: PinboardReader

Defined in: kinds/Pinboard.ts:9

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

• EventReader

Constructors

Constructor

new PinboardReader(kind, context, event): PinboardReader

Defined in: core/EventReader.ts:17

Parameters

kind

number

context

KindContext

event

TrustedEvent

Returns

PinboardReader

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

---

collaborative()

collaborative(): boolean

Defined in: kinds/Pinboard.ts:26

Returns

boolean

---

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

---

description()

description(): undefined | string

Defined in: kinds/Pinboard.ts:14

Returns

undefined | string

---

emojis()

emojis(): Emoji[]

Defined in: core/EventReader.ts:71

Returns

Emoji[]

Inherited from

EventReader.emojis

---

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

---

image()

image(): undefined | string

Defined in: kinds/Pinboard.ts:18

Returns

undefined | string

---

parse()

parse(): this

Defined in: core/EventReader.ts:86

Returns

this

Inherited from

EventReader.parse

---

protect()

protect(): boolean

Defined in: core/EventReader.ts:63

Returns

boolean

Inherited from

EventReader.protect

---

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(): undefined | string

Defined in: kinds/Pinboard.ts:10

Returns

undefined | string

---

topics()

topics(): string[]

Defined in: kinds/Pinboard.ts:22

Returns

string[]

---

zapSplits()

zapSplits(): ZapSplit[]

Defined in: core/EventReader.ts:75

Returns

ZapSplit[]

Inherited from

EventReader.zapSplits