simple-git/promise.d.ts

Simple GIT interface for node.js

import * as errors from './typings/errors';
import * as types from './typings/types';
import * as resp from './typings/response';
import * as simpleGit from './typings/simple-git';
import { MergeResult } from './typings/response';

declare const simplegit: simplegit.SimpleGitExport;

declare namespace simplegit {

   type SimpleGitExport = ((basePath?: string) => simplegit.SimpleGit) & {
      CleanOptions: typeof types.CleanOptions
   };

   type SimpleGit = simpleGit.SimpleGit;

   // errors
   type GitError = errors.GitError;
   type GitConstructError = errors.GitConstructError;
   type GitResponseError<T> = errors.GitResponseError<T>;
   type TaskConfigurationError = errors.TaskConfigurationError;

   // responses
   type BranchSummary = resp.BranchSummary
   type CleanSummary = resp.CleanSummary;
   type CleanMode = types.CleanMode;
   type DiffResult = resp.DiffResult;
   type FetchResult = resp.FetchResult;
   type CommitSummary = resp.CommitSummary;
   type MergeResult = resp.MergeResult;
   type PullResult = resp.PullResult;
   type StatusResult = resp.StatusResult;
   type TagResult = resp.TagResult;

   // types
   type outputHandler = types.outputHandler
   type LogOptions<T = types.DefaultLogFields> = types.LogOptions<T>;
   type Options = types.Options;

   // deprecated
   /** @deprecated use MergeResult */
   type MergeSummary = resp.MergeSummary;
}

export = simplegit;