Class User

A class for a user

Index

Constructors

Properties

Accessors

blockedRelays$ bookmarks$ contacts$ directMessageRelays$ favoriteRelays$ groups$ inboxes$ live$ mailboxes$ mutes$ nprofile npub outboxes$ pointer profile$ searchRelays$

Methods

$$ref addressable replaceable

Constructors

constructor

new User(user: string | ProfilePointer, store: CastRefEventStore): User
Parameters
- user: string | ProfilePointer
- store: CastRefEventStore
Returns User
- Defined in common/src/casts/user.ts:52

Properties

pubkey

pubkey: string

`Static`cache

cache: Map<string, User> = ...

A global cache of pubkey -> User

Accessors

blockedRelays$

get blockedRelays$(): ChainableObservable<BlockedRelays | undefined>
Returns ChainableObservable<BlockedRelays | undefined>
- Defined in common/src/casts/user.ts:202

bookmarks$

get bookmarks$(): ChainableObservable<BookmarksList | undefined>
Returns ChainableObservable<BookmarksList | undefined>
- Defined in common/src/casts/user.ts:151

contacts$

get contacts$(): ChainableObservable<User[]>
Returns ChainableObservable<User[]>
- Defined in common/src/casts/user.ts:110

directMessageRelays$

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

favoriteRelays$

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

groups$

get groups$(): ChainableObservable<GroupsList | undefined>
Gets the users list of NIP-29 groups

Returns ChainableObservable<GroupsList | undefined>
- Defined in common/src/casts/user.ts:233

inboxes$

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

live$

get live$(): ChainableObservable<Casts.Stream | undefined>
Get the latest live stream for the user

Returns ChainableObservable<Casts.Stream | undefined>
- Defined in common/src/casts/user.ts:251

mailboxes$

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

mutes$

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

nprofile

get nprofile(): `nprofile1${string}`
Returns `nprofile1${string}`
- Defined in common/src/casts/user.ts:88

npub

get npub(): `npub1${string}`
Returns `npub1${string}`
- Defined in common/src/casts/user.ts:79

outboxes$

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

pointer

get pointer(): ProfilePointer
Returns ProfilePointer
- Defined in common/src/casts/user.ts:82

profile$

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

searchRelays$

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

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>
- Defined in common/src/casts/user.ts:64

addressable

addressable(
    kind: number,
    identifier: string,
    relays?: string[],
): ChainableObservable<NostrEvent | undefined>
Parameters
- kind: number
- identifier: string
- Optionalrelays: string[]
Returns ChainableObservable<NostrEvent | undefined>
- Defined in common/src/casts/user.ts:96

replaceable

replaceable(
    kind: number,
    identifier?: string,
    relays?: string[],
): ChainableObservable<NostrEvent | undefined>
Parameters
- kind: number
- Optionalidentifier: string
- Optionalrelays: string[]
Returns ChainableObservable<NostrEvent | undefined>
- Defined in common/src/casts/user.ts:93