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

repo

repo(repoSlug: string): RepositoryResource
Returns a RepositoryResource for a given repository slug under this user, providing access to all repository sub-resources including raw, commits, branches, etc.
Parameters
- repoSlug: string
  The repository slug
Returns RepositoryResource
A chainable repository resource
Example
```
const repo    = await bbClient.user('pilmee').repo('my-repo');
const content = await bbClient.user('pilmee').repo('my-repo').raw('src/index.ts');
```
- Defined in src/resources/UserResource.ts:82

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

then

then<TResult1 = BitbucketUser, TResult2 = never>(
    onfulfilled?:
        | null
        | (value: BitbucketUser) => TResult1 | PromiseLike<TResult1>,
    onrejected?: null | (reason: unknown) => TResult2 | PromiseLike<TResult2>,
): 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: null | (value: BitbucketUser) => TResult1 | PromiseLike<TResult1>
- Optionalonrejected: null | (reason: unknown) => TResult2 | PromiseLike<TResult2>
Returns PromiseLike<TResult1 | TResult2>
Implementation of PromiseLike.then
- Defined in src/resources/UserResource.ts:36