Skip to main content

Class: GitRepository

A git repository.

Extends​

  • BaseClient

Constructors​

Constructor​

new GitRepository(ctx?, _id?): GitRepository

Constructor is used for internal usage only, do not create object from it.

Parameters​

ctx?​

Context

_id?​

GitRepositoryID

Returns​

GitRepository

Overrides​

BaseClient.constructor

Methods​

branch()​

branch(name): GitRef

Returns details of a branch.

Parameters​

name​

string

Branch's name (e.g., "main").

Returns​

GitRef

branches()​

branches(opts?): Promise<string[]>

branches that match any of the given glob patterns.

Parameters​

opts?​

GitRepositoryBranchesOpts

Returns​

Promise<string[]>

commit()​

commit(id): GitRef

Returns details of a commit.

Parameters​

id​

string

Identifier of the commit (e.g., "b6315d8f2810962c601af73f86831f6866ea798b").

Returns​

GitRef

head(): GitRef

Returns details for HEAD.

Returns​

GitRef

id()​

id(): Promise<GitRepositoryID>

A unique identifier for this GitRepository.

Returns​

Promise<GitRepositoryID>

latestVersion()​

latestVersion(): GitRef

Returns details for the latest semver tag.

Returns​

GitRef

ref()​

ref(name): GitRef

Returns details of a ref.

Parameters​

name​

string

Ref's name (can be a commit identifier, a tag name, a branch name, or a fully-qualified ref).

Returns​

GitRef

tag()​

tag(name): GitRef

Returns details of a tag.

Parameters​

name​

string

Tag's name (e.g., "v0.3.9").

Returns​

GitRef

tags()​

tags(opts?): Promise<string[]>

tags that match any of the given glob patterns.

Parameters​

opts?​

GitRepositoryTagsOpts

Returns​

Promise<string[]>

with()​

with(arg): GitRepository

Call the provided function with current GitRepository.

This is useful for reusability and readability by not breaking the calling chain.

Parameters​

arg​

(param) => GitRepository

Returns​

GitRepository

withAuthHeader()​

withAuthHeader(header): GitRepository

Header to authenticate the remote with.

Parameters​

Secret

Secret used to populate the Authorization HTTP header

Returns​

GitRepository

Deprecated​

Use "httpAuthHeader" in the constructor instead.

withAuthToken()​

withAuthToken(token): GitRepository

Token to authenticate the remote with.

Parameters​

token​

Secret

Secret used to populate the password during basic HTTP Authorization

Returns​

GitRepository

Deprecated​

Use "httpAuthToken" in the constructor instead.