Welshman

Appearance

Welshman Docs / @welshman/domain / ZapReceiptReader

Class: ZapReceiptReader ​

Defined in: kinds/ZapReceipt.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 ​

Constructors ​

Constructor ​

new ZapReceiptReader(kind, context, event): ZapReceiptReader

Defined in: core/EventReader.ts:17

Parameters ​

kind ​

number

context ​

KindContext

event ​

TrustedEvent

Returns ​

ZapReceiptReader

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

plain? ​

optional plain: TrustedEvent

Defined in: kinds/ZapReceipt.ts:10

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

bolt11() ​

bolt11(): undefined | string

Defined in: kinds/ZapReceipt.ts:20

Returns ​

undefined | string

comment() ​

comment(): undefined | string

Defined in: kinds/ZapReceipt.ts:52

Returns ​

undefined | string

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

eventId() ​

eventId(): undefined | string

Defined in: kinds/ZapReceipt.ts:48

Returns ​

undefined | string

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

invoiceAmount() ​

invoiceAmount(): undefined | number

Defined in: kinds/ZapReceipt.ts:24

Returns ​

undefined | number

parse() ​

parse(): ZapReceiptReader

Defined in: kinds/ZapReceipt.ts:12

Returns ​

ZapReceiptReader

Overrides ​

EventReader.parse

preimage() ​

preimage(): undefined | string

Defined in: kinds/ZapReceipt.ts:56

Returns ​

undefined | string

protect() ​

protect(): boolean

Defined in: core/EventReader.ts:63

Returns ​

boolean

Inherited from ​

EventReader.protect

recipient() ​

recipient(): undefined | string

Defined in: kinds/ZapReceipt.ts:44

Returns ​

undefined | string

request() ​

request(): undefined | TrustedEvent

Defined in: kinds/ZapReceipt.ts:36

Returns ​

undefined | TrustedEvent

room() ​

room(): undefined | string

Defined in: core/EventReader.ts:59

Returns ​

undefined | string

Inherited from ​

EventReader.room

sender() ​

sender(): undefined | string

Defined in: kinds/ZapReceipt.ts:40

Returns ​

undefined | string

tags() ​

tags(): string[][]

Defined in: core/EventReader.ts:43

Returns ​

string[][]

Inherited from ​

EventReader.tags

zapSplits() ​

zapSplits(): ZapSplit[]

Defined in: core/EventReader.ts:75

Returns ​

ZapSplit[]

Inherited from ​

EventReader.zapSplits