Class Note

The base class for all casts

Hierarchy (View Summary)

EventCast<KnownEvent<1>>
- Note

Index

Constructors

Properties

Accessors

author comments$ createdAt id isReply isRoot quotePointers reactions$ references replies$ replyingTo$ seen shares$ threadRoot$ uid zaps$

Methods

Constructors

constructor

new Note(event: NostrEvent, store: CastRefEventStore): Casts.Note
Parameters
- event: NostrEvent
- store: CastRefEventStore
Returns Casts.Note
Overrides EventCast.constructor
- Defined in common/src/casts/note.ts:29

Properties

`Readonly`event

event: KnownEvent

`Readonly`store

store: CastRefEventStore

Accessors

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

comments$

get comments$(): ChainableObservable<Casts.Comment[]>
Gets the NIP-22 comments to this event

Returns ChainableObservable<Casts.Comment[]>
- Defined in common/src/casts/note.ts:82

createdAt

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

id

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

isReply

get isReply(): boolean
Returns boolean
- Defined in common/src/casts/note.ts:36

isRoot

get isRoot(): boolean
Returns boolean
- Defined in common/src/casts/note.ts:39

quotePointers

get quotePointers(): EventPointer[]
An array of events that this note is quoting

Returns EventPointer[]
- Defined in common/src/casts/note.ts:44

reactions$

get reactions$(): ChainableObservable<Casts.Reaction[]>
Returns ChainableObservable<Casts.Reaction[]>
- Defined in common/src/casts/note.ts:95

references

get references(): ThreadReferences
Returns ThreadReferences
- Defined in common/src/casts/note.ts:33

replies$

get replies$(): ChainableObservable<Casts.Note[]>
Gets the NIP-10 replies to this event

Returns ChainableObservable<Casts.Note[]>
- Defined in common/src/casts/note.ts:76

replyingTo$

get replyingTo$(): ChainableObservable<NostrEvent | undefined>
Gets the NIP-10 reply event

Returns ChainableObservable<NostrEvent | undefined>
- Defined in common/src/casts/note.ts:64

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

shares$

get shares$(): ChainableObservable<Share[]>
Returns ChainableObservable<Share[]>
- Defined in common/src/casts/note.ts:90

threadRoot$

get threadRoot$(): ChainableObservable<NostrEvent | undefined>
Gets the NIP-10 root event

Returns ChainableObservable<NostrEvent | undefined>
- Defined in common/src/casts/note.ts:53

uid

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

zaps$

get zaps$(): ChainableObservable<Casts.Zap[]>
Returns ChainableObservable<Casts.Zap[]>
- Defined in common/src/casts/note.ts:87

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