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
|
/* @flow */
/**
* Misc Setup Types
*/
type PromiseLike<R> = {
then<U>(
onFulfill?: (value: R) => Promise<U> | U,
onReject?: (error: any) => Promise<U> | U
): Promise<U>;
}
type ObservableLike = {
subscribe(observer: (value: {}) => void): void;
};
type SpecialReturnTypes =
| PromiseLike<any>
| Iterator<any>
| ObservableLike;
type Constructor = Class<{
constructor(...args: Array<any>): any
}>;
type ErrorValidator =
| Constructor
| RegExp
| string
| ((error: any) => boolean);
/**
* Assertion Types
*/
type AssertContext = {
// Passing assertion.
pass(message?: string): void;
// Failing assertion.
fail(message?: string): void;
// Assert that value is truthy.
truthy(value: mixed, message?: string): void;
// Assert that value is falsy.
falsy(value: mixed, message?: string): void;
// Assert that value is true.
true(value: mixed, message?: string): void;
// Assert that value is false.
false(value: mixed, message?: string): void;
// Assert that value is equal to expected.
is<U>(value: U, expected: U, message?: string): void;
// Assert that value is not equal to expected.
not<U>(value: U, expected: U, message?: string): void;
// Assert that value is deep equal to expected.
deepEqual<U>(value: U, expected: U, message?: string): void;
// Assert that value is not deep equal to expected.
notDeepEqual<U>(value: U, expected: U, message?: string): void;
// Assert that function throws an error or promise rejects.
// @param error Can be a constructor, regex, error message or validation function.
throws: {
(value: PromiseLike<mixed>, error?: ErrorValidator, message?: string): Promise<any>;
(value: () => mixed, error?: ErrorValidator, message?: string): any;
};
// Assert that function doesn't throw an error or promise resolves.
notThrows: {
(value: PromiseLike<mixed>, message?: string): Promise<void>;
(value: () => mixed, message?: string): void;
};
// Assert that contents matches regex.
regex(contents: string, regex: RegExp, message?: string): void;
// Assert that contents matches a snapshot.
snapshot(contents: any, message?: string): void;
// Assert that contents does not match regex.
notRegex(contents: string, regex: RegExp, message?: string): void;
// Assert that error is falsy.
ifError(error: any, message?: string): void;
};
/**
* Context Types
*/
type TestContext = AssertContext & {
plan(count: number): void;
skip: AssertContext;
};
type ContextualTestContext = TestContext & { context: any; };
type ContextualCallbackTestContext = TestContext & { context: any; end(): void; };
/**
* Test Implementations
*/
type TestFunction<T, R> = {
(t: T, ...args: Array<any>): R;
title?: (providedTitle: string, ...args: Array<any>) => string;
};
type TestImplementation<T, R> =
| TestFunction<T, R>
| Array<TestFunction<T, R>>;
type ContextualTest = TestImplementation<ContextualTestContext, SpecialReturnTypes | void>;
type ContextualCallbackTest = TestImplementation<ContextualCallbackTestContext, void>;
/**
* Method Types
*/
type ContextualTestMethod = {
( implementation: ContextualTest): void;
(name: string, implementation: ContextualTest): void;
serial : ContextualTestMethod;
before : ContextualTestMethod;
after : ContextualTestMethod;
skip : ContextualTestMethod;
todo : ContextualTestMethod;
failing : ContextualTestMethod;
only : ContextualTestMethod;
beforeEach : ContextualTestMethod;
afterEach : ContextualTestMethod;
cb : ContextualCallbackTestMethod;
always : ContextualTestMethod;
};
type ContextualCallbackTestMethod = {
( implementation: ContextualCallbackTest): void;
(name: string, implementation: ContextualCallbackTest): void;
serial : ContextualCallbackTestMethod;
before : ContextualCallbackTestMethod;
after : ContextualCallbackTestMethod;
skip : ContextualCallbackTestMethod;
todo : ContextualCallbackTestMethod;
failing : ContextualCallbackTestMethod;
only : ContextualCallbackTestMethod;
beforeEach : ContextualCallbackTestMethod;
afterEach : ContextualCallbackTestMethod;
cb : ContextualCallbackTestMethod;
always : ContextualCallbackTestMethod;
};
/**
* Public API
*/
declare module.exports: {
( run: ContextualTest, ...args: any): void;
(name: string, run: ContextualTest, ...args: any): void;
beforeEach : ContextualTestMethod;
afterEach : ContextualTestMethod;
serial : ContextualTestMethod;
before : ContextualTestMethod;
after : ContextualTestMethod;
skip : ContextualTestMethod;
todo : ContextualTestMethod;
failing : ContextualTestMethod;
only : ContextualTestMethod;
cb : ContextualCallbackTestMethod;
always : ContextualTestMethod;
};
|
