pb.me

pb.me is the resource for the current signed-in account. Each method on this page requires a valid browser session or API key. Use pb.profiles(username) if you require only a public profile.

Fetch the current user

const user = await pb.me()

console.log(user.username)
console.log(user.is_staff)

pb.me() sends GET /user/me and returns Promise<Profile>.

Update the profile

const updated = await pb.me.update({
  display_name: 'New Display Name',
  about: { bio: 'Updated bio text' },
  post_privacy: 'followers',
  space_type: 'custom_free',
})

This is a partial update. Include only the fields that you want to change. Supported fields are display_name, slug, about.bio, space_type, post_privacy, and images.header. The response contains the fields that the server wrote. It does not contain a new full profile. Call pb.me() after the update if you require the full result.

Settings

const settings = await pb.me.settings()
await pb.me.settings({
  dark_mode: true,
  notifications_email: false,
})

Call settings() with no argument to read the settings. Call it with an object to update them. The read result is Record<string, unknown>. Decode each key that you use. Do not cast the full record.

const raw = await pb.me.settings()
const settings = decodeSettings(raw, {
  dark_mode: (value): boolean => {
    if (typeof value !== 'boolean') throw new TypeError('dark_mode must be boolean')
    return value
  },
})

To cancel a settings read without confusing request options with update keys, pass undefined first: pb.me.settings(undefined, { signal }).

Friends

const { friends, count, message } = await pb.me.friends()

for (const friend of friends) {
  console.log(friend.username, friend.online)
}

A friend is a mutual follow. The server returns up to 100 of them in an object containing friends, count, and sometimes message.

Packs

const packs = await pb.me.packs()

This method returns each pack that the current user belongs to. The response includes membership data. The result is not limited to packs that the user owns.

Select a badge

await pb.me.setBadge('founder-badge')

This method sends POST /user/me/badge with the store item ID of an owned badge. The server does not supply a related badge GET operation. The profile from pb.me() contains the active badge.

Storage usage

const usage = await pb.me.storage()

console.log(usage.totalBytes, usage.fileCount, usage.tier)

pb.me.storage() returns StorageUsage. On a storage-provider failure, the response includes error and totalBytes: 0.