Class RootNsite

Readonlyevent

Readonlystore

address

• get address(): string

  The NIP-19 naddr, or nevent for snapshots

  Returns string

address$

• get address$(): Observable<string>

  An observable of the NIP-19 address with relay hints from the authors outboxes

  Returns Observable<string>

aggregateHash

• get aggregateHash(): string | undefined

  The advertised aggregate hash

  Returns string | undefined

appPointers

• get appPointers(): AddressPointer[]

  The upstream app descriptor pointers

  Returns AddressPointer[]

author

• get author(): Casts.User

  Get the User that authored this event

  Returns Casts.User

comments$

• get comments$(): Observable.ChainableObservable<Casts.Comment[]>

  Subscribes to the NIP-22 comments on this nsite

  Returns Observable.ChainableObservable<Casts.Comment[]>

computedAggregateHash

• get computedAggregateHash(): string

  The computed aggregate hash

  Returns string

coordinate

• get coordinate(): string

  The kind:pubkey:identifier address used by snapshot a and A tags

  Returns string

copies$

• get copies$(): Observable.ChainableObservable<Nsite<NsiteEvent>[]>

  Subscribes to sites copied directly from this site

  Returns Observable.ChainableObservable<Nsite<NsiteEvent>[]>

createdAt

• get createdAt(): Date

  Returns the created_at timestamp as a Date object

  Returns Date

description

• get description(): string | undefined

  The site description

  Returns string | undefined

files

• get files(): NsiteFile[]

  The valid file mappings

  Returns NsiteFile[]

hostLabel

• get hostLabel(): string

  The canonical DNS label on an nsite host

  Returns string

id

• get id(): string

  Alias for event.id

  Returns string

isNamed

• get isNamed(): boolean

  Whether this is a kind 35128 named nsite

  Returns boolean

isRoot

• get isRoot(): boolean

  Whether this is a kind 15128 root nsite

  Returns boolean

isSnapshot

• get isSnapshot(): boolean

  Whether this is a kind 5128 snapshot

  Returns boolean

kind

• get kind(): number

  Alias for event.kind

  Returns number

lineage$

• get lineage$(): Observable.ChainableObservable<Nsite<NsiteEvent>[]>

  Subscribes to copied sites and snapshots whose lineage originates from this site

  Returns Observable.ChainableObservable<Nsite<NsiteEvent>[]>

parent$

• get parent$(): Observable.ChainableObservable<Nsite<NsiteEvent> | undefined>

  Subscribes to the immediate parent site

  Returns Observable.ChainableObservable<Nsite<NsiteEvent> | undefined>

parentPointer

• get parentPointer(): AddressPointer | undefined

  The immediate parent site's address

  Returns AddressPointer | undefined

pointer

• get pointer(): AddressPointer | EventPointer

  An address pointer for root and named nsites, or an event pointer for snapshots

  Returns AddressPointer | EventPointer

pointer$

• get pointer$(): Observable<AddressPointer | EventPointer>

  An observable of the pointer with relay hints from the authors outboxes

  Returns Observable<AddressPointer | EventPointer>

reactions$

• get reactions$(): Observable.ChainableObservable<Casts.Reaction[]>

  Subscribes to the reactions to this nsite

  Returns Observable.ChainableObservable<Casts.Reaction[]>

replaceableAddress

• get replaceableAddress(): string | null

  Alias for coordinate

  Returns string | null

root$

• get root$(): Observable.ChainableObservable<Nsite<NsiteEvent> | undefined>

  Subscribes to the origin site of the copy lineage

  Returns Observable.ChainableObservable<Nsite<NsiteEvent> | undefined>

rootPointer

• get rootPointer(): AddressPointer | undefined

  The origin site address of the copy lineage

  Returns AddressPointer | undefined

seen

• get seen(): Set<string> | undefined

  Return the set of relays this event was seen on

  Returns Set<string> | undefined

servers

• get servers(): string[]

  The Blossom server hints

  Returns string[]

servers$

• get servers$(): Observable.ChainableObservable<URL[]>

  Subscribes to manifest server hints followed by the author's Blossom servers

  Returns Observable.ChainableObservable<URL[]>

shares$

• get shares$(): Observable.ChainableObservable<Share[]>

  Subscribes to the shares of this nsite

  Returns Observable.ChainableObservable<Share[]>

snapshots$

• get snapshots$(): Observable.ChainableObservable<NsiteSnapshot[]>

  Subscribes to snapshots of this site

  Returns Observable.ChainableObservable<NsiteSnapshot[]>

source

• get source(): string | undefined

  The source repository or archive URL

  Returns string | undefined

title

• get title(): string | undefined

  The site's display title

  Returns string | undefined

uid

• get uid(): string

  Returns the unique identifier for this event

  Returns string

upstream$

• get upstream$(): Observable.ChainableObservable<Nsite<NsiteEvent> | undefined>

  An alias for the immediate parent site

  Returns Observable.ChainableObservable<Nsite<NsiteEvent> | undefined>

zaps$

• get zaps$(): Observable.ChainableObservable<Casts.Zap[]>

  Subscribes to the zaps of this nsite

  Returns Observable.ChainableObservable<Casts.Zap[]>

resolvePath

• resolvePath(path: string): NsiteFile | undefined

  Resolves a request path with index and not-found fallbacks

  Parameters

  • path: string

  Returns NsiteFile | undefined

url

• url(host: string | URL): URL

  Returns the site's URL on an nsite host

  Parameters

  • host: string | URL

  Returns URL

  Throws

  if the host URL is invalid