-
Notifications
You must be signed in to change notification settings - Fork 7
/
MockXhrServer.d.ts
149 lines (129 loc) · 3.13 KB
/
MockXhrServer.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
import MockXhr from "./MockXhr"
export class MockXhrServer {
/**
* Constructor
*
* @param xhrMock XMLHttpRequest mock class
* @param routes routes
*/
constructor(xhrMock: MockXhr, routes?: object);
/**
* Install the server's XMLHttpRequest mock in the context. Revert with remove().
*
* @param context context object (e.g. global, window)
* @returns this
*/
install(context: object): this;
/**
* Remove the server as the global XMLHttpRequest mock. Reverts the actions of install(global).
*/
remove(): void;
/**
* Disable the effects of the timeout attribute on the XMLHttpRequest mock used by the server.
*/
disableTimeout(): void;
/**
* Enable the effects of the timeout attribute on the XMLHttpRequest mock used by the server.
*/
enableTimeout(): void;
/**
* Add a GET request handler.
*
* @param matcher url matcher
* @param handler request handler
* @returns this
*/
get(
matcher: MockXhrServer.UrlMatcher,
handler: MockXhrServer.Handler
): this;
/**
* Add a POST request handler.
*
* @param matcher url matcher
* @param handler request handler
* @returns this
*/
post(
matcher: MockXhrServer.UrlMatcher,
handler: MockXhrServer.Handler
): this;
/**
* Add a PUT request handler.
*
* @param matcher url matcher
* @param handler request handler
* @returns this
*/
put(
matcher: MockXhrServer.UrlMatcher,
handler: MockXhrServer.Handler
): this;
/**
* Add a DELETE request handler.
*
* @param matcher url matcher
* @param handler request handler
* @returns this
*/
delete(
matcher: MockXhrServer.UrlMatcher,
handler: MockXhrServer.Handler
): this;
/**
* Add a request handler.
*
* @param method HTTP method
* @param matcher url matcher
* @param handler request handler
* @returns this
*/
addHandler(
method: string,
matcher: MockXhrServer.UrlMatcher,
handler: MockXhrServer.Handler
): this;
/**
* Set the default request handler for requests that don't match any route.
*
* @param {object|Function|object[]|Function[]} handler request handler
* @returns this
*/
setDefaultHandler(handler: MockXhrServer.Handler): this;
/**
* Return 404 responses for requests that don't match any route.
*
* @returns this
*/
setDefault404(): this;
/**
* @returns list of requests received by the server. Entries: { method, url }
*/
getRequestLog(): MockXhrServer.RequestLog;
}
export namespace MockXhrServer {
type UrlMatcher =
((url: string) => boolean)
| string
| RegExp
interface MockResponseHandler {
status: number;
statusText: string;
headers: Record<string, string>;
body: string;
}
interface MockCallbackHandler {
(xhr: MockXhr): void
}
type Handler =
(Partial<MockResponseHandler> | MockCallbackHandler)
| (Partial<MockResponseHandler> | MockCallbackHandler)[]
interface RequestLogEntry {
method: string;
url: string;
headers: Record<string, string>;
body?: any
}
type RequestLog = ReadonlyArray<RequestLogEntry>
}
export default MockXhrServer