-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.d.ts
204 lines (179 loc) · 7.61 KB
/
index.d.ts
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
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
// TypeScript typings for "[email protected]".
/** Fluent interface returned by "given". */
interface MochaGivenMethods3<P1, P2, P3> {
/** Defines a test case (for use with BDD interface). */
it(title: string, test: (p1: P1, p2: P2, p3: P3) => void): any;
/** Defines a test case (for use with TDD & qunit interfaces). */
test(title: string, test: (p1: P1, p2: P2, p3: P3) => void): any;
}
/** Fluent interface returned by "given". */
interface MochaGivenMethods2<P1, P2> {
/** Defines a test case (for use with BDD interface). */
it(title: string, test: (p1: P1, p2: P2) => void): any;
/** Defines a test case (for use with TDD & qunit interfaces). */
test(title: string, test: (p1: P1, p2: P2) => void): any;
}
/** Fluent interface returned by "given". */
interface MochaGivenMethods1<P1> {
/** Defines a test case (for use with BDD interface). */
it(title: string, test: (p1: P1) => void): any;
/** Defines a test case (for use with TDD & qunit interfaces). */
test(title: string, test: (p1: P1) => void): any;
}
/**
* Defines set of test data for a test case.
*
* @param { Tuple | Tuple[] } first
* Values to pass to the test. If the arguments themselves are arrays,
* they will be passed as multiple arguments to the test function.
* If a data item is an object, the "description" property is used
* to construct the individual test name.
*
* @param { Tuple[] } params
* Additional values to pass to the test.
*
* @returns
* Fluent interface to define the test that will receive the test data.
*
* @example
* given([1,2,3], [3,2,1]).it("Has invariant sum", (a,b,c) => assert.strictEqual(a+b+c, 6));
*/
export function given<P1, P2, P3>(first: { 0: P1, 1: P2, 2: P3 } | { 0: P1, 1: P2, 2: P3 }[], ...params: { 0: P1, 1: P2, 2: P3 }[]): MochaGivenMethods3<P1, P2, P3>;
/**
* Defines set of test data for a test case.
*
* @param { Tuple | Tuple[] } first
* Values to pass to the test. If the arguments themselves are arrays,
* they will be passed as multiple arguments to the test function.
* If a data item is an object, the "description" property is used
* to construct the individual test name.
*
* @param { Tuple[] } params
* Additional values to pass to the test.
*
* @returns
* Fluent interface to define the test that will receive the test data.
*
* @example
* given([1,2], [2,1]).it("Has invariant sum", (a,b) => assert.strictEqual(a+b, 3));
*/
export function given<P1, P2>(first: { 0: P1, 1: P2 } | { 0: P1, 1: P2 }[], ...params: { 0: P1, 1: P2 }[]): MochaGivenMethods2<P1, P2>;
/**
* Defines set of test data for a test case.
*
* @param { any[] } params
* Values to pass to the test. If a data item is an object, the "description"
* property is used to construct the individual test name.
*
* @returns
* Fluent interface to define the test that will receive the test data.
*
* @example
* const data = [1,2,3,4];
* given(data).it("Is a number", value => assert(typeof value === "number"));
*/
export function given<P1>(params: P1[]): MochaGivenMethods1<P1>;
/**
* Defines set of test data for a test case.
*
* @param { any[] } params
* Values to pass to the test. If a data item is an object, the "description"
* property is used to construct the individual test name.
*
* @returns
* Fluent interface to define the test that will receive the test data.
*
* @example
* given(1,2,3,4).it("Is a number", value => assert(typeof value === "number"));
*/
export function given<P1>(...params: P1[]): MochaGivenMethods1<P1>;
/** Signature of Mocha "done" handler that must be called at the end of asynchronous calls chain in order for the test to pass. */
type DoneHandler = { (): void };
/** Fluent interface returned by "givenAsync". */
interface MochaGivenAsyncMethods3<P1, P2, P3> {
/** Defines an async test case (for use with BDD interface). */
it(title: string, test: (done: DoneHandler, p1: P1, p2: P2, p3: P3) => void): any;
/** Defines an async test case (for use with TDD & qunit interfaces). */
test(title: string, test: (done: DoneHandler, p1: P1, p2: P2, p3: P3) => void): any;
}
/** Fluent interface returned by "givenAsync". */
interface MochaGivenAsyncMethods2<P1, P2> {
/** Defines an async test case (for use with BDD interface). */
it(title: string, test: (done: DoneHandler, p1: P1, p2: P2) => void): any;
/** Defines an async test case (for use with TDD & qunit interfaces). */
test(title: string, test: (done: DoneHandler, p1: P1, p2: P2) => void): any;
}
/** Fluent interface returned by "givenAsync". */
interface MochaGivenAsyncMethods1<P1> {
/** Defines an async test case (for use with BDD interface). */
it(title: string, test: (done: DoneHandler, p1: P1) => void): any;
/** Defines an async test case (for use with TDD & qunit interfaces). */
test(title: string, test: (done: DoneHandler, p1: P1) => void): any;
}
/**
* Defines set of test data for an asynchronous test case.
*
* @param { Tuple | Tuple[] } first
* Values to pass to the test. If the arguments themselves are arrays,
* they will be passed as multiple arguments to the test function.
* If a data item is an object, the "description" property is used
* to construct the individual test name.
*
* @param { Tuple[] } params
* Additional values to pass to the test.
*
* @returns
* Fluent interface to define the asynchronous test that will receive the test data.
*
* @example
* givenAsync([1,2,3], [3,2,1]).it("Has invariant sum", (done,a,b,c) => { assert.strictEqual(a+b+c, 6); done(); });
*/
export function givenAsync<P1, P2, P3>(first: { 0: P1, 1: P2, 2: P3 } | { 0: P1, 1: P2, 2: P3 }[], ...params: { 0: P1, 1: P2, 2: P3 }[]): MochaGivenAsyncMethods3<P1, P2, P3>;
/**
* Defines set of test data for an asynchronous test case.
*
* @param { Tuple | Tuple[] } first
* Values to pass to the test. If the arguments themselves are arrays,
* they will be passed as multiple arguments to the test function.
* If a data item is an object, the "description" property is used
* to construct the individual test name.
*
* @param { Tuple[] } params
* Additional values to pass to the test.
*
* @returns
* Fluent interface to define the asynchronous test that will receive the test data.
*
* @example
* givenAsync([1,2], [2,1]).it("Has invariant sum", (done,a,b) => { assert.strictEqual(a+b, 3); done(); });
*/
export function givenAsync<P1, P2>(first: { 0: P1, 1: P2 } | { 0: P1, 1: P2 }[], ...params: { 0: P1, 1: P2 }[]): MochaGivenAsyncMethods2<P1, P2>;
/**
* Defines set of test data for an asynchronous test case.
*
* @param { any[] } params
* Values to pass to the test. If a data item is an object, the "description"
* property is used to construct the individual test name.
*
* @returns
* Fluent interface to define the asynchronous test that will receive the test data.
*
* @example
* const data = [1,2,3,4];
* givenAsync(data).it("Is a number", (done,value) => { assert(typeof value === "number"); done(); });
*/
export function givenAsync<P1>(params: P1[]): MochaGivenAsyncMethods1<P1>;
/**
* Defines set of test data for an asynchronous test case.
*
* @param { any[] } params
* Values to pass to the test. If a data item is an object, the "description"
* property is used to construct the individual test name.
*
* @returns
* Fluent interface to define the asynchronous test that will receive the test data.
*
* @example
* givenAsync(1,2,3,4).it("Is a number", (done,value) => { assert(typeof value === "number"); done(); });
*/
export function givenAsync<P1>(...params: P1[]): MochaGivenAsyncMethods1<P1>;