Casting Users
The User cast wraps a pubkey into an observable model with reactive access to profiles, contacts, mutes, bookmarks, relay lists, and more. It's the primary way to work with Nostr users in applesauce.
Import castUser from applesauce-common/casts:
import { castUser, User } from "applesauce-common/casts";castUser()
Cast a pubkey (or profile pointer, or event) to a User instance. Users are cached globally, so casting the same pubkey twice returns the same instance.
const user = castUser(pubkey, eventStore);
const user2 = castUser(profilePointer, eventStore);
const user3 = castUser(event, eventStore); // Uses event.pubkeyUser
The User class provides reactive access to all user-related data through observables.
Basic properties
user.pubkey; // Hex pubkey string
user.npub; // NIP-19 encoded npub
user.nprofile; // NIP-19 encoded nprofile with relay hints
user.pointer; // ProfilePointer object with relay hintsRequest Methods
Subscribe to replaceable or addressable events published by the user.
// Replaceable event (e.g., the kind 10002 relay list)
const relayList$ = user.replaceable(10002);
// Addressable event (e.g., the kind 30311 live stream with identifier "my-stream")
const stream$ = user.addressable(30311, "my-stream", relays);Feature observables
applesauce-common adds feature observables to User. Each feature page covers the cast it returns and how to edit it.
| Observables | Feature |
|---|---|
profile$ | Profiles |
contacts$ | Follows |
mutes$ | Mutes & Reports |
mailboxes$, outboxes$, inboxes$ | Mailboxes & Outbox |
bookmarks$ | Bookmarks |
favoriteRelays$, searchRelays$, blockedRelays$, lookupRelayList$, directMessageRelays$ | Relay Lists |
groups$ | Groups |
blossomServers$ | Blossom Servers |
gitRepositories$, gitAuthors$, favoriteGitRepos$, graspServers$ | Git |
nsites$, nsite$, nsiteSnapshots$, napplets$, napplet$ | Nostr Sites, Napplets |
appHandlers$, appRecommendations$ | App Handlers |
User Cache
Users are cached globally by pubkey. This ensures that the same User instance is returned for the same pubkey, which is important for reactive subscriptions.
const user1 = castUser(pubkey, eventStore);
const user2 = castUser(pubkey, eventStore);
console.log(user1 === user2); // trueTo clear the cache (rarely needed):
User.cache.clear();TIP
All $ suffixed properties on User return reactive observables that update when the underlying data changes. Use use$ from applesauce-react/hooks to consume them in React components.