Skip to content
View as Markdown

GitService

Section titled “GitService”

Constructors

Section titled “Constructors”

Constructor

Section titled “Constructor”
new GitService(transport: HttpTransport): GitService;

Parameters:

  • transport HttpTransport

Returns:

  • GitService

Methods

Section titled “Methods”

add()

Section titled “add()”
add(path: string, files: string[]): Promise<void>;

Parameters:

  • path string
  • files string[]

Returns:

  • Promise<void>

addRemote()

Section titled “addRemote()”
addRemote(path: string, name: string, url: string): Promise<void>;

Parameters:

  • path string
  • name string
  • url string

Returns:

  • Promise<void>

checkoutBranch()

Section titled “checkoutBranch()”
checkoutBranch(path: string, branch: string): Promise<void>;

Parameters:

  • path string
  • branch string

Returns:

  • Promise<void>

clone()

Section titled “clone()”
clone(url: string, options: CloneOptions): Promise<void>;

Parameters:

  • url string
  • options CloneOptions

Returns:

  • Promise<void>

commit()

Section titled “commit()”
commit(
   path: string,
   message: string,
   options: CommitOptions): Promise<GitCommitResponse>;

Parameters:

  • path string
  • message string
  • options CommitOptions

Returns:

  • Promise<GitCommitResponse>

createBranch()

Section titled “createBranch()”
createBranch(path: string, name: string): Promise<void>;

Parameters:

  • path string
  • name string

Returns:

  • Promise<void>

deleteBranch()

Section titled “deleteBranch()”
deleteBranch(path: string, name: string): Promise<void>;

Parameters:

  • path string
  • name string

Returns:

  • Promise<void>

getConfig()

Section titled “getConfig()”
getConfig(key: string, options: GitConfigOptions = {}): Promise<string | null>;

Parameters:

  • key string
  • options GitConfigOptions = {}

Returns:

  • Promise<string | null>

history()

Section titled “history()”
history(path: string): Promise<ListResult<GitCommit>>;

Parameters:

  • path string

Returns:

  • Promise<ListResult<GitCommit>>

init()

Section titled “init()”
init(path: string, options: InitOptions = {}): Promise<void>;

Parameters:

  • path string
  • options InitOptions = {}

Returns:

  • Promise<void>

listBranches()

Section titled “listBranches()”
listBranches(path: string): Promise<ListResult<string>>;

List branches; response always has {items,nextCursor}.

Parameters:

  • path string

Returns:

  • Promise<ListResult<string>>

listRemotes()

Section titled “listRemotes()”
listRemotes(path: string): Promise<ListResult<GitRemote>>;

Parameters:

  • path string

Returns:

  • Promise<ListResult<GitRemote>>

pull()

Section titled “pull()”
pull(path: string, options: CredentialOptions = {}): Promise<void>;

Parameters:

  • path string
  • options CredentialOptions = {}

Returns:

  • Promise<void>

push()

Section titled “push()”
push(path: string, options: PushOptions = {}): Promise<void>;

Parameters:

  • path string
  • options PushOptions = {}

Returns:

  • Promise<void>

reset()

Section titled “reset()”
reset(path: string, options: ResetOptions = {}): Promise<void>;

Parameters:

  • path string
  • options ResetOptions = {}

Returns:

  • Promise<void>

restore()

Section titled “restore()”
restore(path: string, files: string[], options: RestoreOptions = {}): Promise<void>;

Parameters:

  • path string
  • files string[]
  • options RestoreOptions = {}

Returns:

  • Promise<void>

setConfig()

Section titled “setConfig()”
setConfig(key: string, value: string, options: GitConfigOptions = {}): Promise<void>;

Parameters:

  • key string
  • value string
  • options GitConfigOptions = {}

Returns:

  • Promise<void>

status()

Section titled “status()”
status(path: string): Promise<GitStatus>;

Parameters:

  • path string

Returns:

  • Promise<GitStatus>

CloneOptions

Section titled “CloneOptions”

Properties:

  • path string
  • branch? string
  • commitId? string
  • depth? number
  • insecureSkipTls? boolean
  • username? string
  • password? string
  • timeout? number

CommitOptions

Section titled “CommitOptions”

Properties:

  • author string
  • email string
  • allowEmpty? boolean

CredentialOptions

Section titled “CredentialOptions”

Properties:

  • username? string
  • password? string
  • branch? string
  • remote? string
  • timeout? number

GitCommit

Section titled “GitCommit”
type GitCommit = toolbox.CommitInfo

One commit from git.history(), as the daemon renders it.

ListBranchResponse

Section titled “ListBranchResponse”
type ListBranchResponse = toolbox.BranchList

PushOptions

Section titled “PushOptions”

Properties:

  • username? string
  • password? string
  • branch? string
  • remote? string
  • timeout? number
  • setUpstream? boolean

ResetOptions

Section titled “ResetOptions”

Properties:

  • mode? string
  • target? string
  • files? string[]

RestoreOptions

Section titled “RestoreOptions”

Properties:

  • staged? boolean
  • worktree? boolean
  • source? string

GitConfigScope

Section titled “GitConfigScope”
type GitConfigScope = 'global' | 'local'

GitRemote

Section titled “GitRemote”

Properties:

  • name string
  • url string

GitStatus

Section titled “GitStatus”

Properties:

  • currentBranch string
  • ahead? number
  • behind? number
  • branchPublished? boolean
  • fileStatus? Array<{ name: string; staging?: string; worktree?: string }>

GitCommitResponse

Section titled “GitCommitResponse”
type GitCommitResponse = toolbox.CommitResponse