/
glossary.ts
68 lines (59 loc) · 2.17 KB
/
glossary.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
import type { PartialDeep } from 'type-fest'
import type { IsomorphicResponse } from '@mswjs/interceptors'
import {
DefaultBodyType,
RequestHandler,
RequestHandlerDefaultInfo,
} from '../handlers/RequestHandler'
import {
LifeCycleEventEmitter,
LifeCycleEventsMap,
SharedOptions,
} from '../sharedOptions'
import { MockedRequest } from '../utils/request/MockedRequest'
export type ServerLifecycleEventsMap = LifeCycleEventsMap<IsomorphicResponse>
export interface SetupServer {
/**
* Starts requests interception based on the previously provided request handlers.
* @see {@link https://mswjs.io/docs/api/setup-server/listen `server.listen()`}
*/
listen(options?: PartialDeep<SharedOptions>): void
/**
* Stops requests interception by restoring all augmented modules.
* @see {@link https://mswjs.io/docs/api/setup-server/close `server.close()`}
*/
close(): void
/**
* Prepends given request handlers to the list of existing handlers.
* @see {@link https://mswjs.io/docs/api/setup-server/use `server.use()`}
*/
use(...handlers: RequestHandler[]): void
/**
* Marks all request handlers that respond using `res.once()` as unused.
* @see {@link https://mswjs.io/docs/api/setup-server/restore-handlers `server.restore-handlers()`}
*/
restoreHandlers(): void
/**
* Resets request handlers to the initial list given to the `setupServer` call, or to the explicit next request handlers list, if given.
* @see {@link https://mswjs.io/docs/api/setup-server/reset-handlers `server.reset-handlers()`}
*/
resetHandlers(...nextHandlers: RequestHandler[]): void
/**
* Returns a readonly list of currently active request handlers.
* @see {@link https://mswjs.io/docs/api/setup-server/list-handlers `server.listHandlers()`}
*/
listHandlers(): ReadonlyArray<
RequestHandler<
RequestHandlerDefaultInfo,
MockedRequest<DefaultBodyType>,
any,
MockedRequest<DefaultBodyType>
>
>
/**
* Lists all active request handlers.
* @see {@link https://mswjs.io/docs/api/setup-server/print-handlers `server.print-handlers()`}
*/
printHandlers(): void
events: LifeCycleEventEmitter<ServerLifecycleEventsMap>
}