/
base.d.ts
132 lines (122 loc) 路 3.93 KB
/
base.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
export type ErrorValidator
= (new (...args: any[]) => any)
| RegExp
| string
| ((error: any) => boolean);
export interface Observable {
subscribe(observer: (value: {}) => void): void;
}
export type Test = (t: TestContext) => PromiseLike<void> | Iterator<any> | Observable | void;
export type GenericTest<T> = (t: GenericTestContext<T>) => PromiseLike<void> | Iterator<any> | Observable | void;
export type CallbackTest = (t: CallbackTestContext) => void;
export type GenericCallbackTest<T> = (t: GenericCallbackTestContext<T>) => void;
export interface Context<T> { context: T }
export type AnyContext = Context<any>;
export type ContextualTest = GenericTest<AnyContext>;
export type ContextualCallbackTest = GenericCallbackTest<AnyContext>;
export interface AssertContext {
/**
* Passing assertion.
*/
pass(message?: string): void;
/**
* Failing assertion.
*/
fail(message?: string): void;
/**
* Assert that value is truthy.
*/
truthy(value: any, message?: string): void;
/**
* Assert that value is falsy.
*/
falsy(value: any, message?: string): void;
/**
* Assert that value is true.
*/
true(value: any, message?: string): void;
/**
* Assert that value is false.
*/
false(value: any, 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<any>, error?: ErrorValidator, message?: string): Promise<any>;
throws(value: () => void, error?: ErrorValidator, message?: string): any;
/**
* Assert that function doesn't throw an error or promise resolves.
*/
notThrows(value: PromiseLike<any>, message?: string): Promise<void>;
notThrows(value: () => void, 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;
}
export interface TestContext extends AssertContext {
/**
* Plan how many assertion there are in the test.
* The test will fail if the actual assertion count doesn't match planned assertions.
*/
plan(count: number): void;
skip: AssertContext;
}
export interface CallbackTestContext extends TestContext {
/**
* End the test.
*/
end(): void;
}
export type GenericTestContext<T> = TestContext & T;
export type GenericCallbackTestContext<T> = CallbackTestContext & T;
export interface Macro<T> {
(t: T, ...args: any[]): void;
title? (providedTitle: string, ...args: any[]): string;
}
export type Macros<T> = Macro<T> | Macro<T>[];
interface RegisterBase<T> {
(name: string, run: GenericTest<T>): void;
(run: GenericTest<T>): void;
(name: string, run: Macros<GenericTestContext<T>>, ...args: any[]): void;
(run: Macros<GenericTestContext<T>>, ...args: any[]): void;
}
interface CallbackRegisterBase<T> {
(name: string, run: GenericCallbackTest<T>): void;
(run: GenericCallbackTest<T>): void;
(name: string, run: Macros<GenericCallbackTestContext<T>>, ...args: any[]): void;
(run: Macros<GenericCallbackTestContext<T>>, ...args: any[]): void;
}
export default test;
export const test: RegisterContextual<any>;
export interface RegisterContextual<T> extends Register<Context<T>> {
}