simple-git/dist/src/lib/errors/git-response-error.d.ts

Simple GIT interface for node.js

import { GitError } from './git-error';
/**
 * The `GitResponseError` is the wrapper for a parsed response that is treated as
 * a fatal error, for example attempting a `merge` can leave the repo in a corrupted
 * state when there are conflicts so the task will reject rather than resolve.
 *
 * For example, catching the merge conflict exception:
 *
 * ```typescript
 import { gitP, SimpleGit, GitResponseError, MergeSummary } from 'simple-git';

 const git = gitP(repoRoot);
 const mergeOptions: string[] = ['--no-ff', 'other-branch'];
 const mergeSummary: MergeSummary = await git.merge(mergeOptions)
      .catch((e: GitResponseError<MergeSummary>) => e.git);

 if (mergeSummary.failed) {
   // deal with the error
 }
 ```
 */
export declare class GitResponseError<T = any> extends GitError {
    /**
     * `.git` access the parsed response that is treated as being an error
     */
    readonly git: T;
    constructor(
    /**
     * `.git` access the parsed response that is treated as being an error
     */
    git: T, message?: string);
}