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 git.ts:61
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

branches

branches(): Promise<Branch[]>

- Defined in git.ts:78
inheritdoc

Returns Promise<Branch[]>

changes

changes(): Promise<UncommitedFileChange[]>

- Defined in git.ts:243
inheritdoc

Returns Promise<UncommitedFileChange[]>

exec

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

- Defined in git.ts:318
Executes the Git client and returns the stdout.

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

The promise with the standard output.

execFile

execFile(args: any[], opts?: ExecFileOptions): Promise<ExecResult>

- Defined in git.ts:332
Executes the Git client.

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

The promise with the result.

version

version(): Promise<string>

- Defined in git.ts:349
Detects the version of the underlying Git client.

Returns Promise<string>

The promise with the version.

Generated using TypeDoc