Class ReposClient

Index

Constructors

Methods

createRepo deleteRepo getRepo listRepos listReposIter updateRepo

Constructors

constructor

new ReposClient(options: ClientOptions): ReposClient
Parameters
- options: ClientOptions
Returns ReposClient
- Defined in client.ts:60

Methods

createRepo

createRepo(
req: CreateRepoRequest,
options?: CallOptions,
): Promise<CreateRepoResponse>
Creates a repo in the workspace and links it to the remote Git repo specified. Note that repos created programmatically must be linked to a remote Git repo, unlike repos created in the browser.
Parameters
- req: CreateRepoRequest
- Optionaloptions: CallOptions
Returns Promise<CreateRepoResponse>
- Defined in client.ts:80

deleteRepo

deleteRepo(
req: DeleteRepoRequest,
options?: CallOptions,
): Promise<DeleteRepoResponse>
Deletes the specified repo.
Parameters
- req: DeleteRepoRequest
- Optionaloptions: CallOptions
Returns Promise<DeleteRepoResponse>
- Defined in client.ts:110

getRepo

getRepo(req: GetRepoRequest, options?: CallOptions): Promise<GetRepoResponse>
Returns the repo with the given repo ID.
Parameters
- req: GetRepoRequest
- Optionaloptions: CallOptions
Returns Promise<GetRepoResponse>
- Defined in client.ts:139

listRepos

listRepos(
req: ListReposRequest,
options?: CallOptions,
): Promise<ListReposResponse>
Returns repos that the calling user has Manage permissions on. Use next_page_token to iterate through additional pages.

Deprecated: This operation does not return a complete list of the repos in the workspace, because repos with the Git CLI enabled are not included in its results. Instead, use the Repos and Workspace APIs to find repos and their associated metadata in the workspace.
Parameters
- req: ListReposRequest
- Optionaloptions: CallOptions
Returns Promise<ListReposResponse>
- Defined in client.ts:175

listReposIter

listReposIter(
req: ListReposRequest,
options?: CallOptions,
): AsyncGenerator<RepoInfo>
Parameters
- req: ListReposRequest
- Optionaloptions: CallOptions
Returns AsyncGenerator<RepoInfo>
- Defined in client.ts:212

updateRepo

updateRepo(
req: UpdateRepoRequest,
options?: CallOptions,
): Promise<UpdateRepoResponse>
Updates the repo to a different branch or tag, or updates the repo to the latest commit on the same branch.
Parameters
- req: UpdateRepoRequest
- Optionaloptions: CallOptions
Returns Promise<UpdateRepoResponse>
- Defined in client.ts:233