TypeScript SDK Reference
api/client.gen.GitRepository
A git repository.
Hierarchy
-
BaseClient↳
GitRepository
Constructors
constructor
new GitRepository(parent?, _id?): GitRepository
Constructor is used for internal usage only, do not create object from it.
Parameters
| Name | Type |
|---|---|
parent? | Object |
parent.ctx | Context |
parent.queryTree? | QueryTree[] |
_id? | GitRepositoryID |
Returns
Overrides
BaseClient.constructor
Properties
_id
Private Optional Readonly _id: GitRepositoryID = undefined
Methods
branch
branch(name): GitRef
Returns details of a branch.
Parameters
| Name | Type | Description |
|---|---|---|
name | string | Branch's name (e.g., "main"). |
Returns
commit
commit(id): GitRef
Returns details of a commit.
Parameters
| Name | Type | Description |
|---|---|---|
id | string | Identifier of the commit (e.g., "b6315d8f2810962c601af73f86831f6866ea798b"). |
Returns
head
head(): GitRef
Returns details for HEAD.
Returns
id
id(): Promise<GitRepositoryID>
A unique identifier for this GitRepository.
Returns
Promise<GitRepositoryID>
ref
ref(name): GitRef
Returns details of a ref.
Parameters
| Name | Type | Description |
|---|---|---|
name | string | Ref's name (can be a commit identifier, a tag name, a branch name, or a fully-qualified ref). |
Returns
tag
tag(name): GitRef
Returns details of a tag.
Parameters
| Name | Type | Description |
|---|---|---|
name | string | Tag's name (e.g., "v0.3.9"). |
Returns
tags
tags(opts?): Promise<string[]>
tags that match any of the given glob patterns.
Parameters
| Name | Type |
|---|---|
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
| Name | Type |
|---|---|
arg | (param: GitRepository) => GitRepository |
Returns
withAuthHeader
withAuthHeader(header): GitRepository
Header to authenticate the remote with.
Parameters
| Name | Type | Description |
|---|---|---|
header | Secret | Secret used to populate the Authorization HTTP header |
Returns
withAuthToken
withAuthToken(token): GitRepository
Token to authenticate the remote with.
Parameters
| Name | Type | Description |
|---|---|---|
token | Secret | Secret used to populate the password during basic HTTP Authorization |