Class Article

The base class for all casts

Hierarchy (View Summary)

EventCast<ArticleEvent>
- Article

Index

Constructors

Properties

Accessors

address address$ author createdAt id image pointer pointer$ published publishedDate reactions$ seen summary title uid

Methods

Constructors

constructor

new Article(event: NostrEvent, store: CastRefEventStore): Article
Parameters
- event: NostrEvent
- store: CastRefEventStore
Returns Article
Overrides EventCast.constructor
- Defined in common/src/casts/article.ts:18

Properties

`Readonly`event

event: ArticleEvent

`Readonly`store

store: CastRefEventStore

Accessors

address

get address(): `naddr1${string}`
Returns `naddr1${string}`
- Defined in common/src/casts/article.ts:50

address$

get address$(): Observable<`naddr1${string}`>
An observable of the address with relay hints from the authors outboxes

Returns Observable<`naddr1${string}`>
- Defined in common/src/casts/article.ts:54

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

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

image

get image(): string | undefined
Returns string | undefined
- Defined in common/src/casts/article.ts:26

pointer

get pointer(): AddressPointer
Returns AddressPointer
- Defined in common/src/casts/article.ts:39

pointer$

get pointer$(): Observable<AddressPointer>
An observable of the address with relay hints from the authors outboxes

Returns Observable<AddressPointer>
- Defined in common/src/casts/article.ts:43

published

get published(): number
Returns number
- Defined in common/src/casts/article.ts:32

publishedDate

get publishedDate(): Date
Returns Date
- Defined in common/src/casts/article.ts:35

reactions$

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

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/article.ts:29

title

get title(): string
Returns string
- Defined in common/src/casts/article.ts:23

uid

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

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