103 lines
4.0 KiB
TypeScript
Executable File
103 lines
4.0 KiB
TypeScript
Executable File
import { SharedOptions, LifeCycleEventEmitter, LifeCycleEventsMap } from "../core/sharedOptions";
|
|
import { RequestHandler } from "../core/handlers/RequestHandler";
|
|
import { WebSocketHandler } from "../core/handlers/WebSocketHandler";
|
|
import { SetupApi } from "../core/SetupApi";
|
|
|
|
type FindWorker = (scriptUrl: string, mockServiceWorkerUrl: string) => boolean;
|
|
interface StartOptions extends SharedOptions {
|
|
/**
|
|
* Service Worker registration options.
|
|
*/
|
|
serviceWorker?: {
|
|
/**
|
|
* Custom url to the worker script.
|
|
* @default "/mockServiceWorker.js"
|
|
*/
|
|
url?: string;
|
|
options?: RegistrationOptions;
|
|
};
|
|
/**
|
|
* Disables the logging of the intercepted requests
|
|
* into browser's console.
|
|
* @default false
|
|
*/
|
|
quiet?: boolean;
|
|
/**
|
|
* Defers any network requests until the Service Worker
|
|
* instance is activated.
|
|
* @default true
|
|
*/
|
|
waitUntilReady?: boolean;
|
|
/**
|
|
* A custom lookup function to find a Mock Service Worker in the list
|
|
* of all registered Service Workers on the page.
|
|
*/
|
|
findWorker?: FindWorker;
|
|
}
|
|
type StartReturnType = Promise<ServiceWorkerRegistration | undefined>;
|
|
type StopHandler = () => void;
|
|
interface SetupWorker {
|
|
/**
|
|
* Registers and activates the mock Service Worker.
|
|
*
|
|
* @see {@link https://mswjs.io/docs/api/setup-worker/start `worker.start()` API reference}
|
|
*/
|
|
start: (options?: StartOptions) => StartReturnType;
|
|
/**
|
|
* Stops requests interception for the current client.
|
|
*
|
|
* @see {@link https://mswjs.io/docs/api/setup-worker/stop `worker.stop()` API reference}
|
|
*/
|
|
stop: StopHandler;
|
|
/**
|
|
* Prepends given request handlers to the list of existing handlers.
|
|
* @param {RequestHandler[]} handlers List of runtime request handlers.
|
|
*
|
|
* @see {@link https://mswjs.io/docs/api/setup-worker/use `worker.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-worker/restore-handlers `worker.restoreHandlers()` API reference}
|
|
*/
|
|
restoreHandlers: () => void;
|
|
/**
|
|
* Resets request handlers to the initial list given to the `setupWorker` call, or to the explicit next request handlers list, if given.
|
|
* @param {RequestHandler[]} nextHandlers List of the new initial request handlers.
|
|
*
|
|
* @see {@link https://mswjs.io/docs/api/setup-worker/reset-handlers `worker.resetHandlers()` 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-worker/list-handlers `worker.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>;
|
|
}
|
|
|
|
declare class SetupWorkerApi extends SetupApi<LifeCycleEventsMap> implements SetupWorker {
|
|
private context;
|
|
constructor(...handlers: Array<RequestHandler | WebSocketHandler>);
|
|
private createWorkerContext;
|
|
start(options?: StartOptions): StartReturnType;
|
|
stop(): void;
|
|
}
|
|
/**
|
|
* Sets up a requests interception in the browser with the given request handlers.
|
|
* @param {RequestHandler[]} handlers List of request handlers.
|
|
*
|
|
* @see {@link https://mswjs.io/docs/api/setup-worker `setupWorker()` API reference}
|
|
*/
|
|
declare function setupWorker(...handlers: Array<RequestHandler | WebSocketHandler>): SetupWorker;
|
|
|
|
export { type SetupWorker, SetupWorkerApi, type StartOptions, setupWorker };
|