Logo DataHubClient

RepositoryApi Type

Client for repository branch and commit operations. See the .

Constructors

Constructor Description

RepositoryApi(baseUrl, auth, http)

Full Usage: RepositoryApi(baseUrl, auth, http)

Parameters:
Returns: RepositoryApi
baseUrl : string
auth : Authentication
http : IHttpClient
Returns: RepositoryApi

Instance members

Instance member Description

this.GetBranchAsync

Full Usage: this.GetBranchAsync

Parameters:
    projectId : int - The project identifier.
    branch : string - The branch name.

Returns: Async<Branch>

Gets a single branch by name.

projectId : int

The project identifier.

branch : string

The branch name.

Returns: Async<Branch>

this.GetCommitAsync

Full Usage: this.GetCommitAsync

Parameters:
    projectId : int - The project identifier.
    sha : string - The commit SHA.

Returns: Async<Commit>

Gets a single commit by SHA.

projectId : int

The project identifier.

sha : string

The commit SHA.

Returns: Async<Commit>

this.ListBranchesAsync

Full Usage: this.ListBranchesAsync

Parameters:
    projectId : int - The project identifier.
    ?search : string - Optional branch-name search term.

Returns: Async<ResizeArray<Branch>>

Lists branches for a project.

projectId : int

The project identifier.

?search : string

Optional branch-name search term.

Returns: Async<ResizeArray<Branch>>

this.ListCommitsAsync

Full Usage: this.ListCommitsAsync

Parameters:
    projectId : int - The project identifier.
    ?refName : string - Optional branch, tag, or commit SHA to list from.
    ?path : string - Optional repository path used to filter commits.

Returns: Async<ResizeArray<Commit>>

Lists commits for a project.

projectId : int

The project identifier.

?refName : string

Optional branch, tag, or commit SHA to list from.

?path : string

Optional repository path used to filter commits.

Returns: Async<ResizeArray<Commit>>

Type something to start searching.