GitService

Constructors

Constructor

new GitService(transport: HttpTransport): GitService;

Parameters:

• transport HttpTransport

Returns:

• GitService

Methods

add()

add(path: string, files: string[]): Promise<void>;

Parameters:

• path string
• files string[]

Returns:

• Promise<void>

addRemote()

addRemote(path: string, name: string, url: string): Promise<void>;

Parameters:

• path string
• name string
• url string

Returns:

• Promise<void>

checkoutBranch()

checkoutBranch(path: string, branch: string): Promise<void>;

Parameters:

• path string
• branch string

Returns:

• Promise<void>

clone()

clone(url: string, options: CloneOptions): Promise<void>;

Parameters:

• url string
• options CloneOptions

Returns:

• Promise<void>

commit()

commit(
   path: string,
   message: string,
   options: CommitOptions): Promise<GitCommitResponse>;

Parameters:

• path string
• message string
• options CommitOptions

Returns:

• Promise<GitCommitResponse>

createBranch()

createBranch(path: string, name: string): Promise<void>;

Parameters:

• path string
• name string

Returns:

• Promise<void>

deleteBranch()

deleteBranch(path: string, name: string): Promise<void>;

Parameters:

• path string
• name string

Returns:

• Promise<void>

getConfig()

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

Parameters:

• key string
• options GitConfigOptions = {}

Returns:

• Promise<string | null>

history()

history(path: string): Promise<ListResult<GitCommit>>;

Parameters:

• path string

Returns:

• Promise<ListResult<GitCommit>>

init()

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

Parameters:

• path string
• options InitOptions = {}

Returns:

• Promise<void>

listBranches()

listBranches(path: string): Promise<ListResult<string>>;

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

Parameters:

• path string

Returns:

• Promise<ListResult<string>>

listRemotes()

listRemotes(path: string): Promise<ListResult<GitRemote>>;

Parameters:

• path string

Returns:

• Promise<ListResult<GitRemote>>

pull()

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

Parameters:

• path string
• options CredentialOptions = {}

Returns:

• Promise<void>

push()

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

Parameters:

• path string
• options PushOptions = {}

Returns:

• Promise<void>

reset()

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

Parameters:

• path string
• options ResetOptions = {}

Returns:

• Promise<void>

restore()

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

Parameters:

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

Returns:

• Promise<void>

setConfig()

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

Parameters:

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

Returns:

• Promise<void>

status()

status(path: string): Promise<GitStatus>;

Parameters:

• path string

Returns:

• Promise<GitStatus>

CloneOptions

Properties:

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

CommitOptions

Properties:

• author string
• email string
• allowEmpty? boolean

CredentialOptions

Properties:

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

GitCommit

type GitCommit = toolbox.CommitInfo

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

ListBranchResponse

type ListBranchResponse = toolbox.BranchList

PushOptions

Properties:

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

ResetOptions

Properties:

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

RestoreOptions

Properties:

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

GitConfigScope

type GitConfigScope = 'global' | 'local'

GitRemote

Properties:

• name string
• url string

GitStatus

type GitStatus = OptionalizeNullable<Schema<"StatusResponse">>

GitCommitResponse

type GitCommitResponse = toolbox.CommitResponse