Class User

A class representing a Nostr user

Hierarchy (View Summary)

Casts.PubkeyCast
- User

Index

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:22

Properties

`Readonly`pointer

pointer: ProfilePointer

`Readonly`store

store: Casts.CastRefEventStore

`Static`cache

cache: Map<string, Casts.User>

A global cache of pubkey -> User

Accessors

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:226

mutes$

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

nprofile

get nprofile(): `nprofile1${string}`
Returns `nprofile1${string}`
- Defined in packages/core/dist/casts/user.d.ts:14

npub

get npub(): `npub1${string}`
Returns `npub1${string}`
- Defined in packages/core/dist/casts/user.d.ts:13

outboxes$

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

profile$

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

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:24

searchRelays$

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

trustedProviders$

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

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:26

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:18

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:16

Class User

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Casts.User

Properties

Readonlypointer

Readonlystore

Staticcache

Accessors

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>

favoriteRelays$

Returns Observable.ChainableObservable<Casts.FavoriteRelays | undefined>

groups$

Returns Observable.ChainableObservable<GroupsList | undefined>

inboxes$

Returns Observable.ChainableObservable<string[] | undefined>

mailboxes$

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

mutes$

Returns Observable.ChainableObservable<Mutes | undefined>

nprofile

Returns `nprofile1${string}`

npub

Returns `npub1${string}`

outboxes$

Returns Observable.ChainableObservable<string[] | undefined>

profile$

Returns Observable.ChainableObservable<Profile | undefined>

profileBadges$

Returns Observable.ChainableObservable<Casts.ProfileBadges | undefined>

pubkey

Returns string

searchRelays$

Returns Observable.ChainableObservable<SearchRelays | undefined>

trustedProviders$

Returns Observable.ChainableObservable<TrustedProviderList | undefined>

Methods

Protected$$ref

Type Parameters

Parameters

Returns Observable.ChainableObservable<Return>

addressable

Parameters

Returns Observable.ChainableObservable<NostrEvent | undefined>

replaceable

Parameters

Returns Observable.ChainableObservable<NostrEvent | undefined>

Settings

On This Page

`Readonly`pointer

`Readonly`store

`Static`cache

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

`Protected`$$ref