import { PartialDeep } from 'type-fest'; import { HttpNetworkFrameEventMap } from "../core/experimental/frames/http-frame"; import { WebSocketNetworkFrameEventMap } from "../core/experimental/frames/websocket-frame"; import { AnyHandler, HandlersController, HandlersControllerState } from "../core/experimental/handlers-controller"; import { SharedOptions, LifeCycleEventEmitter } from "../core/sharedOptions"; import { Interceptor } from '@mswjs/interceptors'; import { NetworkApi, DefineNetworkOptions } from "../core/experimental/define-network"; import { InterceptorSource } from "../core/experimental/sources/interceptor-source"; import * as rettime from 'rettime'; interface ListenOptions extends SharedOptions { } interface SetupServerCommon { /** * Starts the request 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) => void; /** * Stops the request 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) => 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) => 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; /** * 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; } interface SetupServer extends SetupServerCommon { /** * Wraps the given function in a boundary. Any changes to the * network behavior (e.g. adding runtime request handlers via * `server.use()`) will be scoped to this boundary only. * @param callback A function to run (e.g. a test) * * @see {@link https://mswjs.io/docs/api/setup-server/boundary `server.boundary()` API reference} */ boundary: , R>(callback: (...args: Args) => R) => (...args: Args) => R; } declare class AsyncHandlersController extends HandlersController { #private; constructor(initialHandlers: Array); protected getState(): { initialHandlers: Partial>; handlers: Partial>; }; protected setState(nextState: HandlersControllerState): void; boundary, R>(callback: (...args: Args) => R): (...args: Args) => R; } /** * @deprecated * Please use the `defineNetwork` API instead. */ declare class SetupServerCommonApi implements SetupServerCommon { protected network: NetworkApi<[InterceptorSource]>; constructor(interceptors: Array>, handlers: Array | HandlersController); get events(): rettime.Emitter; listen(options?: PartialDeep): void; use(...handlers: Array): void; resetHandlers(...nextHandlers: Array): void; restoreHandlers(): void; listHandlers(): ReadonlyArray; close(): void; } declare const defaultNetworkOptions: DefineNetworkOptions<[InterceptorSource]>; /** * Enables request interception in Node.js with the given request handlers. * @see {@link https://mswjs.io/docs/api/setup-server `setupServer()` API reference} */ declare function setupServer(...handlers: Array): SetupServer; /** * @deprecated * Please use the `defineNetwork` API instead. */ declare class SetupServerApi extends SetupServerCommonApi implements SetupServer { #private; boundary: AsyncHandlersController['boundary']; constructor(handlers: Array, interceptors: Array>); } export { AsyncHandlersController, type SetupServer, SetupServerApi, SetupServerCommonApi, defaultNetworkOptions, setupServer };