Class ZapGoal

Cast a kind 9041 event to a ZapGoal

Hierarchy (View Summary)

EventCast<ZapGoalEvent>
- ZapGoal

Index

Constructors

Properties

Accessors

amount author beneficiaries closedAt createdAt description id image progress$ relays seen summary uid zaps$

Methods

Constructors

constructor

new ZapGoal(event: NostrEvent, store: CastRefEventStore): Casts.ZapGoal
Parameters
- event: NostrEvent
- store: CastRefEventStore
Returns Casts.ZapGoal
Overrides EventCast.constructor
- Defined in common/src/casts/zap-goal.ts:20

Properties

`Readonly`event

event: ZapGoalEvent

`Readonly`store

store: CastRefEventStore

Accessors

amount

get amount(): number | undefined
Returns number | undefined
- Defined in common/src/casts/zap-goal.ts:25

author

get author(): User
Get the User that authored this event

Returns User
Inherited from EventCast.author
- Defined in common/src/casts/cast.ts:59

beneficiaries

get beneficiaries(): ZapSplit[] | undefined
Returns ZapSplit[] | undefined
- Defined in common/src/casts/zap-goal.ts:40

closedAt

get closedAt(): number | undefined
Returns number | undefined
- Defined in common/src/casts/zap-goal.ts:31

createdAt

get createdAt(): Date
Returns Date
Inherited from EventCast.createdAt
- Defined in common/src/casts/cast.ts:54

description

get description(): string
Returns string
- Defined in common/src/casts/zap-goal.ts:43

id

get id(): string
Returns string
Inherited from EventCast.id
- Defined in common/src/casts/cast.ts:47

image

get image(): string | undefined
Returns string | undefined
- Defined in common/src/casts/zap-goal.ts:34

progress$

get progress$(): ChainableObservable<ZapGoalProgress | undefined>
An observable of the goal progress

Returns ChainableObservable<ZapGoalProgress | undefined>
- Defined in common/src/casts/zap-goal.ts:55

relays

get relays(): string[]
Returns string[]
- Defined in common/src/casts/zap-goal.ts:28

seen

get seen(): Set<string> | undefined
Return the set of relays this event was seen on

Returns Set<string> | undefined
Inherited from EventCast.seen
- Defined in common/src/casts/cast.ts:64

summary

get summary(): string | undefined
Returns string | undefined
- Defined in common/src/casts/zap-goal.ts:37

uid

get uid(): string
Returns string
Inherited from EventCast.uid
- Defined in common/src/casts/cast.ts:50

zaps$

get zaps$(): ChainableObservable<KnownEvent<9735>[]>
An observable of all zaps contributing to this goal

Returns ChainableObservable<KnownEvent<9735>[]>
- Defined in common/src/casts/zap-goal.ts:48

Methods

`Protected`$$ref

$$ref<Return extends unknown>(
key: string,
builder: (store: CastRefEventStore) => Observable<Return>,
): ChainableObservable<Return>
Internal method for creating a reference
Type Parameters
- Return extends unknown
Parameters
- key: string
- builder: (store: CastRefEventStore) => Observable<Return>
Returns ChainableObservable<Return>
Inherited from EventCast.$$ref
- Defined in common/src/casts/cast.ts:78