TypeScript SDK Reference
api/client.gen.GitRef
A git ref (tag, branch, or commit).
Hierarchy
-
BaseClient
↳
GitRef
Constructors
constructor
new GitRef(parent?
, _id?
, _commit?
): GitRef
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? | GitRefID |
_commit? | string |
Returns
Overrides
BaseClient.constructor
Properties
_commit
Private
Optional
Readonly
_commit: string
= undefined
_id
Private
Optional
Readonly
_id: GitRefID
= undefined
Methods
commit
commit(): Promise
<string
>
The resolved commit id at this ref.
Returns
Promise
<string
>
id
id(): Promise
<GitRefID
>
A unique identifier for this GitRef.
Returns
Promise
<GitRefID
>
tree
tree(): Directory
The filesystem tree at this ref.