Spaces:
Running
Running
import { RequestHandler } from "../core/handlers/RequestHandler"; | |
import { BatchInterceptor, Interceptor, HttpRequestEventMap } from '@mswjs/interceptors'; | |
import { SharedOptions, LifeCycleEventEmitter, LifeCycleEventsMap } from "../core/sharedOptions"; | |
import { SetupApi } from "../core/SetupApi"; | |
import { WebSocketHandler } from "../core/handlers/WebSocketHandler"; | |
import { PartialDeep } from 'type-fest'; | |
interface SetupServerCommon { | |
/** | |
* Starts requests interception based on the previously provided request handlers. | |
* | |
* @see {@link https://mswjs.io/docs/api/setup-server/listen `server.listen()` API reference} | |
*/ | |
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()` API reference} | |
*/ | |
close(): void; | |
/** | |
* Prepends given request handlers to the list of existing handlers. | |
* | |
* @see {@link https://mswjs.io/docs/api/setup-server/use `server.use()` API reference} | |
*/ | |
use(...handlers: Array<RequestHandler | WebSocketHandler>): 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()` API reference} | |
*/ | |
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()` API reference} | |
*/ | |
resetHandlers(...nextHandlers: Array<RequestHandler | WebSocketHandler>): void; | |
/** | |
* Returns a readonly list of currently active request handlers. | |
* | |
* @see {@link https://mswjs.io/docs/api/setup-server/list-handlers `server.listHandlers()` API reference} | |
*/ | |
listHandlers(): ReadonlyArray<RequestHandler | WebSocketHandler>; | |
/** | |
* Life-cycle events. | |
* Life-cycle events allow you to subscribe to the internal library events occurring during the request/response handling. | |
* | |
* @see {@link https://mswjs.io/docs/api/life-cycle-events Life-cycle Events API reference} | |
*/ | |
events: LifeCycleEventEmitter<LifeCycleEventsMap>; | |
} | |
/** | |
* @note This API is extended by both "msw/node" and "msw/native" | |
* so be minding about the things you import! | |
*/ | |
declare class SetupServerCommonApi extends SetupApi<LifeCycleEventsMap> implements SetupServerCommon { | |
protected readonly interceptor: BatchInterceptor<Array<Interceptor<HttpRequestEventMap>>, HttpRequestEventMap>; | |
private resolvedOptions; | |
constructor(interceptors: Array<{ | |
new (): Interceptor<HttpRequestEventMap>; | |
}>, handlers: Array<RequestHandler | WebSocketHandler>); | |
/** | |
* Subscribe to all requests that are using the interceptor object | |
*/ | |
private init; | |
listen(options?: Partial<SharedOptions>): void; | |
close(): void; | |
} | |
/** | |
* Sets up a requests interception in React Native with the given request handlers. | |
* @param {RequestHandler[]} handlers List of request handlers. | |
* | |
* @see {@link https://mswjs.io/docs/api/setup-server `setupServer()` API reference} | |
*/ | |
declare function setupServer(...handlers: Array<RequestHandler>): SetupServerCommonApi; | |
export { setupServer }; | |