aboutsummaryrefslogtreecommitdiff
path: root/node_modules/simple-git/promise.d.ts
blob: 7f70976e6bbe1fe9229e8c4e563ab6c83cfa4c9c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
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';

/**
 * @deprecated
 *
 * simple-git has supported promises / async await since version 2.6.0.
 * Importing from 'simple-git/promise' has been deprecated and will be
 * removed by July 2022.
 *
 * To upgrade, change all 'simple-git/promise' imports to just 'simple-git'
 */
declare const simplegit: simplegit.SimpleGitExport;

declare namespace simplegit {

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

   /**
    * @deprecated
    *
    * simple-git has supported promises / async await since version 2.6.0.
    * Importing from 'simple-git/promise' has been deprecated and will be
    * removed by July 2022.
    *
    * To upgrade, change all 'simple-git/promise' imports to just 'simple-git'
    */
   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 CommitResult = resp.CommitResult;
   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;
   /** @deprecated use CommitResult */
   type CommitSummary = resp.CommitResult;
}

/**
 * @deprecated
 *
 * simple-git has supported promises / async await since version 2.6.0.
 * Importing from 'simple-git/promise' has been deprecated and will be
 * removed by July 2022.
 *
 * To upgrade, change all 'simple-git/promise' imports to just 'simple-git'
 */
export = simplegit;