Class UserResource

Represents a Bitbucket user resource.

Implements PromiseLike<BitbucketUser> so it can be awaited directly to fetch user info.

Example

// Await directly to get user info
const user = await bbClient.user('pilmee');

Implements

PromiseLike<BitbucketUser>

Index

Methods

get repo repos settings sshKeys then

Methods

get

get(): Promise<BitbucketUser>
Fetches the user details.

GET /rest/api/latest/users/{slug}

Returns Promise<BitbucketUser>
The user object
- Defined in src/resources/UserResource.ts:52

repo

repo(repoSlug: string): RepositoryResource
Parameters
- repoSlug: string
Returns RepositoryResource
- Defined in src/resources/UserResource.ts:110

repos

repos(params?: ReposParams): Promise<PagedResponse<BitbucketRepository>>
Fetches repositories belonging to this user.

GET /rest/api/latest/users/{slug}/repos
Parameters
- Optionalparams: ReposParams
  Optional filters: limit, start, name, permission
Returns Promise<PagedResponse<BitbucketRepository>>
A paged response of repositories
- Defined in src/resources/UserResource.ts:64

settings

settings(): Promise<BitbucketUserSettings>
Fetches the settings of this user.

GET /rest/api/latest/users/{slug}/settings

Returns Promise<BitbucketUserSettings>
The user settings object
- Defined in src/resources/UserResource.ts:106

sshKeys

sshKeys(params?: SshKeysParams): Promise<PagedResponse<BitbucketSshKey>>
Fetches the SSH keys associated with this user.

GET /rest/api/latest/users/{slug}/ssh
Parameters
- Optionalparams: SshKeysParams
  Optional pagination: limit, start
Returns Promise<PagedResponse<BitbucketSshKey>>
A paged response of SSH keys
- Defined in src/resources/UserResource.ts:92

then

then<TResult1 = BitbucketUser, TResult2 = never>(
    onfulfilled?:
        | ((value: BitbucketUser) => TResult1 | PromiseLike<TResult1>)
        | null,
    onrejected?: ((reason: unknown) => TResult2 | PromiseLike<TResult2>) | null,
): PromiseLike<TResult1 | TResult2>
Allows the resource to be awaited directly, resolving with the user info. Delegates to UserResource.get.
Type Parameters
- TResult1 = BitbucketUser
- TResult2 = never
Parameters
- Optionalonfulfilled: ((value: BitbucketUser) => TResult1 | PromiseLike<TResult1>) | null
- Optionalonrejected: ((reason: unknown) => TResult2 | PromiseLike<TResult2>) | null
Returns PromiseLike<TResult1 | TResult2>
Implementation of PromiseLike.then
- Defined in src/resources/UserResource.ts:38