Class User

A class representing a Nostr user

Hierarchy (View Summary)

Casts.PubkeyCast
- User

Constructors

constructor

new User(pointer: ProfilePointer, store: Casts.CastRefEventStore): Casts.User
Parameters
- pointer: ProfilePointer
- store: Casts.CastRefEventStore
Returns Casts.User
Inherited from PubkeyCast.constructor
- Defined in packages/core/dist/casts/pubkey.d.ts:27

Properties

`Readonly`pointer

pointer: ProfilePointer

`Readonly`store

store: Casts.CastRefEventStore

`Static`cache

cache: Map<string, WeakRef<Casts.User>>

A global cache of pubkey -> weak User reference

`Static` `Optional`cacheRegistry

cacheRegistry?: FinalizationRegistry<string>

Cleans up dead cache entries when their instances are garbage collected

Accessors

directMessageRelays$

get directMessageRelays$(): Observable.ChainableObservable<string[] | undefined>
Returns Observable.ChainableObservable<string[] | undefined>
- Defined in packages/common/src/casts/user.ts:348

favoriteEmojis$

get favoriteEmojis$(): Observable.ChainableObservable<
FavoriteEmojis
| undefined,
>
Returns Observable.ChainableObservable<FavoriteEmojis | undefined>
- Defined in packages/common/src/casts/user.ts:337

favoriteGitRepos$

get favoriteGitRepos$(): Observable.ChainableObservable<
FavoriteGitRepos
| undefined,
>
Returns Observable.ChainableObservable<FavoriteGitRepos | undefined>
- Defined in packages/common/src/casts/user.ts:340

favoriteRelays$

get favoriteRelays$(): Observable.ChainableObservable<
Casts.FavoriteRelays
| undefined,
>
Returns Observable.ChainableObservable<Casts.FavoriteRelays | undefined>
- Defined in packages/common/src/casts/user.ts:338

gitAuthors$

get gitAuthors$(): Observable.ChainableObservable<GitAuthors | undefined>
Returns Observable.ChainableObservable<GitAuthors | undefined>
- Defined in packages/common/src/casts/user.ts:339

gitRepositories$

get gitRepositories$(): Observable.ChainableObservable<Casts.GitRepository[]>
Subscribes to the git repositories announced by the user that are in the event store

Returns Observable.ChainableObservable<Casts.GitRepository[]>
- Defined in packages/common/src/casts/user.ts:344

graspServers$

get graspServers$(): Observable.ChainableObservable<
Casts.GitGraspList
| undefined,
>
Returns Observable.ChainableObservable<Casts.GitGraspList | undefined>
- Defined in packages/common/src/casts/user.ts:342

groups$

get groups$(): Observable.ChainableObservable<GroupsList | undefined>
Returns Observable.ChainableObservable<GroupsList | undefined>
- Defined in packages/common/src/casts/user.ts:350

identities$

get identities$(): Observable.ChainableObservable<
Casts.ExternalIdentities
| undefined,
>
Returns Observable.ChainableObservable<Casts.ExternalIdentities | undefined>
- Defined in packages/common/src/casts/user.ts:341

inboxes$

get inboxes$(): Observable.ChainableObservable<string[] | undefined>
Returns Observable.ChainableObservable<string[] | undefined>
- Defined in packages/common/src/casts/user.ts:335

lookupRelayList$

get lookupRelayList$(): Observable.ChainableObservable<
LookupRelayList
| undefined,
>
Returns Observable.ChainableObservable<LookupRelayList | undefined>
- Defined in packages/common/src/casts/user.ts:346

mailboxes$

get mailboxes$(): Observable.ChainableObservable<
{ inboxes: string[]; outboxes: string[] }
| undefined,
>
Returns Observable.ChainableObservable<
{ inboxes: string[]; outboxes: string[] }
| undefined,
>
- Defined in packages/common/src/casts/user.ts:333

mutes$

get mutes$(): Observable.ChainableObservable<Mutes | undefined>
Returns Observable.ChainableObservable<Mutes | undefined>
- Defined in packages/common/src/casts/user.ts:332

napplet$

get napplet$(): Observable.ChainableObservable<RootNapplet | undefined>
Subscribes to the user's root (kind 15129) napplet

Returns Observable.ChainableObservable<RootNapplet | undefined>
- Defined in packages/common/src/casts/napplet.ts:268

napplets$

get napplets$(): Observable.ChainableObservable<Casts.Napplet<NappletEvent>[]>
Subscribes to the user's root and named napplets

Returns Observable.ChainableObservable<Casts.Napplet<NappletEvent>[]>
- Defined in packages/common/src/casts/napplet.ts:266

nprofile

get nprofile(): `nprofile1${string}`
Returns the NIP-19 nprofile for this user

Returns `nprofile1${string}`
- Defined in packages/core/dist/casts/user.d.ts:19

npub

get npub(): `npub1${string}`
Returns the NIP-19 npub for this user

Returns `npub1${string}`
- Defined in packages/core/dist/casts/user.d.ts:17

nsite$

get nsite$(): Observable.ChainableObservable<RootNsite | undefined>
Subscribes to the user's root (kind 15128) nsite

Returns Observable.ChainableObservable<RootNsite | undefined>
- Defined in packages/common/src/casts/nsite.ts:322

nsites$

get nsites$(): Observable.ChainableObservable<Nsite<NsiteEvent>[]>
Subscribes to the user's root and named nsites

Returns Observable.ChainableObservable<Nsite<NsiteEvent>[]>
- Defined in packages/common/src/casts/nsite.ts:320

nsiteSnapshots$

get nsiteSnapshots$(): Observable.ChainableObservable<NsiteSnapshot[]>
Subscribes to the user's nsite snapshots

Returns Observable.ChainableObservable<NsiteSnapshot[]>
- Defined in packages/common/src/casts/nsite.ts:324

outboxes$

get outboxes$(): Observable.ChainableObservable<string[] | undefined>
Returns Observable.ChainableObservable<string[] | undefined>
- Defined in packages/common/src/casts/user.ts:334

profile$

get profile$(): Observable.ChainableObservable<Profile | undefined>
Returns Observable.ChainableObservable<Profile | undefined>
- Defined in packages/common/src/casts/user.ts:330

profileBadges$

get profileBadges$(): Observable.ChainableObservable<
Casts.ProfileBadges
| undefined,
>
Returns Observable.ChainableObservable<Casts.ProfileBadges | undefined>
- Defined in packages/common/src/casts/profile-badges.ts:91

pubkey

get pubkey(): string
The hex pubkey represented by this cast

Returns string
Inherited from PubkeyCast.pubkey
- Defined in packages/core/dist/casts/pubkey.d.ts:29

reports$

get reports$(): Observable.ChainableObservable<Casts.Report[]>
Subscribes to reports referencing this user in the store

Returns Observable.ChainableObservable<Casts.Report[]>
- Defined in packages/common/src/casts/user.ts:327

reportsSent$

get reportsSent$(): Observable.ChainableObservable<Casts.Report[]>
Subscribes to reports published by this user in the store

Returns Observable.ChainableObservable<Casts.Report[]>
- Defined in packages/common/src/casts/user.ts:329

searchRelays$

get searchRelays$(): Observable.ChainableObservable<SearchRelays | undefined>
Returns Observable.ChainableObservable<SearchRelays | undefined>
- Defined in packages/common/src/casts/user.ts:345

status$

get status$(): Observable.ChainableObservable<Casts.UserStatus | undefined>
The user's "general" status

Returns Observable.ChainableObservable<Casts.UserStatus | undefined>
- Defined in packages/common/src/casts/user-status.ts:101

statuses$

get statuses$(): Observable.ChainableObservable<Casts.UserStatus[]>
All of the user's statuses that have not been cleared

Returns Observable.ChainableObservable<Casts.UserStatus[]>
- Defined in packages/common/src/casts/user-status.ts:103

trustedProviders$

get trustedProviders$(): Observable.ChainableObservable<
TrustedProviderList
| undefined,
>
Returns Observable.ChainableObservable<TrustedProviderList | undefined>
- Defined in packages/common/src/casts/user.ts:351

Methods

`Protected`$$ref

$$ref<Return extends unknown>(
key: string,
builder: (store: Casts.CastRefEventStore) => Observable<Return>,
): Observable.ChainableObservable<Return>
Internal method for creating a cached observable reference
Type Parameters
- Return extends unknown
Parameters
- key: string
- builder: (store: Casts.CastRefEventStore) => Observable<Return>
Returns Observable.ChainableObservable<Return>
Inherited from PubkeyCast.$$ref
- Defined in packages/core/dist/casts/pubkey.d.ts:31

addressable

addressable(
    kind: number,
    identifier: string,
    relays?: string[],
): Observable.ChainableObservable<NostrEvent | undefined>
Subscribe to an addressable event for this user
Parameters
- kind: number
- identifier: string
- Optionalrelays: string[]
Returns Observable.ChainableObservable<NostrEvent | undefined>
- Defined in packages/core/dist/casts/user.d.ts:23

replaceable

replaceable(
    kind: number,
    identifier?: string,
    relays?: string[],
): Observable.ChainableObservable<NostrEvent | undefined>
Subscribe to a replaceable event for this user
Parameters
- kind: number
- Optionalidentifier: string
- Optionalrelays: string[]
Returns Observable.ChainableObservable<NostrEvent | undefined>
- Defined in packages/core/dist/casts/user.d.ts:21

timeline$

timeline$(
    input:
        | number
        | number[]
        | Omit<Filter, "authors">
        | Omit<Filter, "authors">[],
): Observable<NostrEvent[]>
Creates an observable of a timeline of events created by this user
Parameters
- input: number | number[] | Omit<Filter, "authors"> | Omit<Filter, "authors">[]
  The filter(s) for the timeline or kind(s)
Returns Observable<NostrEvent[]>
A timeline observable of events by the user rom the event store
- Defined in packages/core/dist/casts/user.d.ts:29
timeline$<T extends Casts.EventCast<NostrEvent>>(
    input:
        | number
        | number[]
        | Omit<Filter, "authors">
        | Omit<Filter, "authors">[],
    cast?: Casts.CastConstructor<T>,
): Observable<T[]>
Creates an observable of a timeline of events created by this user
Type Parameters
- T extends Casts.EventCast<NostrEvent>
Parameters
- input: number | number[] | Omit<Filter, "authors"> | Omit<Filter, "authors">[]
  The filter(s) for the timeline or kind(s)
- Optionalcast: Casts.CastConstructor<T>
Returns Observable<T[]>
A timeline observable of events by the user rom the event store
- Defined in packages/core/dist/casts/user.d.ts:30

Class User

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Casts.User

Properties

Readonlypointer

Readonlystore

Staticcache

Static OptionalcacheRegistry

Accessors

appHandlers$

Returns Observable.ChainableObservable<Casts.AppHandler[]>

appRecommendations$

Returns Observable.ChainableObservable<Casts.AppRecommendation[]>

badgeAwards$

Returns Observable.ChainableObservable<Casts.BadgeAward[]>

blockedRelays$

Returns Observable.ChainableObservable<BlockedRelays | undefined>

blossomServers$

Returns Observable.ChainableObservable<URL[] | undefined>

bookmarks$

Returns Observable.ChainableObservable<BookmarksList | undefined>

contacts$

Returns Observable.ChainableObservable<Casts.User[]>

directMessageRelays$

Returns Observable.ChainableObservable<string[] | undefined>

favoriteEmojis$

Returns Observable.ChainableObservable<FavoriteEmojis | undefined>

favoriteGitRepos$

Returns Observable.ChainableObservable<FavoriteGitRepos | undefined>

favoriteRelays$

Returns Observable.ChainableObservable<Casts.FavoriteRelays | undefined>

gitAuthors$

Returns Observable.ChainableObservable<GitAuthors | undefined>

gitRepositories$

Returns Observable.ChainableObservable<Casts.GitRepository[]>

graspServers$

Returns Observable.ChainableObservable<Casts.GitGraspList | undefined>

groups$

Returns Observable.ChainableObservable<GroupsList | undefined>

identities$

Returns Observable.ChainableObservable<Casts.ExternalIdentities | undefined>

inboxes$

Returns Observable.ChainableObservable<string[] | undefined>

lookupRelayList$

Returns Observable.ChainableObservable<LookupRelayList | undefined>

mailboxes$

Returns Observable.ChainableObservable< { inboxes: string[]; outboxes: string[] } | undefined,>

mutes$

Returns Observable.ChainableObservable<Mutes | undefined>

napplet$

Returns Observable.ChainableObservable<RootNapplet | undefined>

napplets$

Returns Observable.ChainableObservable<Casts.Napplet<NappletEvent>[]>

nprofile

Returns `nprofile1${string}`

npub

Returns `npub1${string}`

nsite$

Returns Observable.ChainableObservable<RootNsite | undefined>

nsites$

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

nsiteSnapshots$

Returns Observable.ChainableObservable<NsiteSnapshot[]>

outboxes$

Returns Observable.ChainableObservable<string[] | undefined>

profile$

Returns Observable.ChainableObservable<Profile | undefined>

profileBadges$

Returns Observable.ChainableObservable<Casts.ProfileBadges | undefined>

pubkey

Returns string

reports$

`Readonly`pointer

`Readonly`store

`Static`cache

`Static` `Optional`cacheRegistry

Returns Observable.ChainableObservable<
{ inboxes: string[]; outboxes: string[] }
| undefined,
>

`Protected`$$ref