Class GitClient

A git client.

Hierarchy

GitClient

Implements

SourceControlClient

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new GitClient(executable: GitExecutable, cwd?: string): GitClient

- Defined in scm/git.ts:56
Initializes a new instance of that class.

Parameters
- executable: GitExecutable
  
  The data of the executable.
- Optional cwd: string
Returns GitClient

Properties

cwd

cwd: string

Gets the current working directory.

executable

executable: GitExecutable

The data of the executable.

Methods

exec

exec(args: any[], opts?: ExecFileOptions): Promise<ExecFileResult>

- Defined in scm/git.ts:93
Executes the Git client.

Parameters
- args: any[]
  
  Arguments for the execution.
- Optional opts: ExecFileOptions
Returns Promise<ExecFileResult>

The promise with the result.

execSync

execSync(args: any[], opts?: ExecFileOptions): string

- Defined in scm/git.ts:113
Executes the Git client (sync).

Parameters
- args: any[]
  
  Arguments for the execution.
- Optional opts: ExecFileOptions
Returns string

The result.

Generated using TypeDoc