msw 0.24.0 → 0.24.4

package/lib/types/rest.d.ts

@@ -1,6 +1,14 @@
 import { RequestHandler, ResponseResolver, MockedRequest, DefaultRequestBodyType, RequestParams } from './utils/handlers/requestHandler';
 import { Mask } from './setupWorker/glossary';
 import { set } from './context/set';
+import { status } from './context/status';
+import { cookie } from './context/cookie';
+import { body } from './context/body';
+import { text } from './context/text';
+import { json } from './context/json';
+import { xml } from './context/xml';
+import { delay } from './context/delay';
+import { fetch } from './context/fetch';
 import { matchRequestUrl } from './utils/matching/matchRequestUrl';
 export declare enum RESTMethods {
     HEAD = "HEAD",
@@ -11,166 +19,88 @@ export declare enum RESTMethods {
     OPTIONS = "OPTIONS",
     DELETE = "DELETE"
 }
-export declare const restContext: {
+export interface RestContext {
     set: typeof set;
-    status: (statusCode: number, statusText?: string | undefined) => import("./response").ResponseTransformer<any>;
-    cookie: (name: string, value: string, options?: import("cookie").CookieSerializeOptions | undefined) => import("./response").ResponseTransformer<any>;
-    body: <BodyType extends string | Blob | ArrayBufferView | ArrayBuffer | ReadableStream<any> | FormData>(value: BodyType) => import("./response").ResponseTransformer<BodyType>;
-    text: <BodyType_1 extends string>(body: BodyType_1) => import("./response").ResponseTransformer<BodyType_1>;
-    json: <BodyTypeJSON>(body: BodyTypeJSON) => import("./response").ResponseTransformer<string>;
-    xml: <BodyType_2 extends string>(body: BodyType_2) => import("./response").ResponseTransformer<BodyType_2>;
-    delay: (durationMs?: number | undefined) => import("./response").ResponseTransformer<any>;
-    fetch: (input: string | MockedRequest<DefaultRequestBodyType, RequestParams>, requestInit?: RequestInit) => any;
-};
+    status: typeof status;
+    cookie: typeof cookie;
+    text: typeof text;
+    body: typeof body;
+    json: typeof json;
+    xml: typeof xml;
+    delay: typeof delay;
+    fetch: typeof fetch;
+}
+export declare const restContext: RestContext;
 export interface ParsedRestRequest {
     match: ReturnType<typeof matchRequestUrl>;
 }
 export declare const rest: {
-    head: <RequestBodyType = DefaultRequestBodyType, ResponseBodyType = any, RequestParamsType extends RequestParams = RequestParams>(mask: Mask, resolver: ResponseResolver<MockedRequest<RequestBodyType, RequestParamsType>, {
-        set: typeof set;
-        status: (statusCode: number, statusText?: string | undefined) => import("./response").ResponseTransformer<any>;
-        cookie: (name: string, value: string, options?: import("cookie").CookieSerializeOptions | undefined) => import("./response").ResponseTransformer<any>;
-        body: <BodyType extends string | Blob | ArrayBufferView | ArrayBuffer | ReadableStream<any> | FormData>(value: BodyType) => import("./response").ResponseTransformer<BodyType>;
-        text: <BodyType_1 extends string>(body: BodyType_1) => import("./response").ResponseTransformer<BodyType_1>;
-        json: <BodyTypeJSON>(body: BodyTypeJSON) => import("./response").ResponseTransformer<string>;
-        xml: <BodyType_2 extends string>(body: BodyType_2) => import("./response").ResponseTransformer<BodyType_2>;
-        delay: (durationMs?: number | undefined) => import("./response").ResponseTransformer<any>;
-        fetch: (input: string | MockedRequest<DefaultRequestBodyType, RequestParams>, requestInit?: RequestInit) => any;
-    }, ResponseBodyType>) => RequestHandler<MockedRequest<RequestBodyType, RequestParamsType>, {
-        set: typeof set;
-        status: (statusCode: number, statusText?: string | undefined) => import("./response").ResponseTransformer<any>;
-        cookie: (name: string, value: string, options?: import("cookie").CookieSerializeOptions | undefined) => import("./response").ResponseTransformer<any>;
-        body: <BodyType extends string | Blob | ArrayBufferView | ArrayBuffer | ReadableStream<any> | FormData>(value: BodyType) => import("./response").ResponseTransformer<BodyType>;
-        text: <BodyType_1 extends string>(body: BodyType_1) => import("./response").ResponseTransformer<BodyType_1>;
-        json: <BodyTypeJSON>(body: BodyTypeJSON) => import("./response").ResponseTransformer<string>;
-        xml: <BodyType_2 extends string>(body: BodyType_2) => import("./response").ResponseTransformer<BodyType_2>;
-        delay: (durationMs?: number | undefined) => import("./response").ResponseTransformer<any>;
-        fetch: (input: string | MockedRequest<DefaultRequestBodyType, RequestParams>, requestInit?: RequestInit) => any;
-    }, ParsedRestRequest, MockedRequest<RequestBodyType, RequestParams>, ResponseBodyType>;
-    get: <RequestBodyType = DefaultRequestBodyType, ResponseBodyType = any, RequestParamsType extends RequestParams = RequestParams>(mask: Mask, resolver: ResponseResolver<MockedRequest<RequestBodyType, RequestParamsType>, {
-        set: typeof set;
-        status: (statusCode: number, statusText?: string | undefined) => import("./response").ResponseTransformer<any>;
-        cookie: (name: string, value: string, options?: import("cookie").CookieSerializeOptions | undefined) => import("./response").ResponseTransformer<any>;
-        body: <BodyType extends string | Blob | ArrayBufferView | ArrayBuffer | ReadableStream<any> | FormData>(value: BodyType) => import("./response").ResponseTransformer<BodyType>;
-        text: <BodyType_1 extends string>(body: BodyType_1) => import("./response").ResponseTransformer<BodyType_1>;
-        json: <BodyTypeJSON>(body: BodyTypeJSON) => import("./response").ResponseTransformer<string>;
-        xml: <BodyType_2 extends string>(body: BodyType_2) => import("./response").ResponseTransformer<BodyType_2>;
-        delay: (durationMs?: number | undefined) => import("./response").ResponseTransformer<any>;
-        fetch: (input: string | MockedRequest<DefaultRequestBodyType, RequestParams>, requestInit?: RequestInit) => any;
-    }, ResponseBodyType>) => RequestHandler<MockedRequest<RequestBodyType, RequestParamsType>, {
-        set: typeof set;
-        status: (statusCode: number, statusText?: string | undefined) => import("./response").ResponseTransformer<any>;
-        cookie: (name: string, value: string, options?: import("cookie").CookieSerializeOptions | undefined) => import("./response").ResponseTransformer<any>;
-        body: <BodyType extends string | Blob | ArrayBufferView | ArrayBuffer | ReadableStream<any> | FormData>(value: BodyType) => import("./response").ResponseTransformer<BodyType>;
-        text: <BodyType_1 extends string>(body: BodyType_1) => import("./response").ResponseTransformer<BodyType_1>;
-        json: <BodyTypeJSON>(body: BodyTypeJSON) => import("./response").ResponseTransformer<string>;
-        xml: <BodyType_2 extends string>(body: BodyType_2) => import("./response").ResponseTransformer<BodyType_2>;
-        delay: (durationMs?: number | undefined) => import("./response").ResponseTransformer<any>;
-        fetch: (input: string | MockedRequest<DefaultRequestBodyType, RequestParams>, requestInit?: RequestInit) => any;
-    }, ParsedRestRequest, MockedRequest<RequestBodyType, RequestParams>, ResponseBodyType>;
-    post: <RequestBodyType = DefaultRequestBodyType, ResponseBodyType = any, RequestParamsType extends RequestParams = RequestParams>(mask: Mask, resolver: ResponseResolver<MockedRequest<RequestBodyType, RequestParamsType>, {
-        set: typeof set;
-        status: (statusCode: number, statusText?: string | undefined) => import("./response").ResponseTransformer<any>;
-        cookie: (name: string, value: string, options?: import("cookie").CookieSerializeOptions | undefined) => import("./response").ResponseTransformer<any>;
-        body: <BodyType extends string | Blob | ArrayBufferView | ArrayBuffer | ReadableStream<any> | FormData>(value: BodyType) => import("./response").ResponseTransformer<BodyType>;
-        text: <BodyType_1 extends string>(body: BodyType_1) => import("./response").ResponseTransformer<BodyType_1>;
-        json: <BodyTypeJSON>(body: BodyTypeJSON) => import("./response").ResponseTransformer<string>;
-        xml: <BodyType_2 extends string>(body: BodyType_2) => import("./response").ResponseTransformer<BodyType_2>;
-        delay: (durationMs?: number | undefined) => import("./response").ResponseTransformer<any>;
-        fetch: (input: string | MockedRequest<DefaultRequestBodyType, RequestParams>, requestInit?: RequestInit) => any;
-    }, ResponseBodyType>) => RequestHandler<MockedRequest<RequestBodyType, RequestParamsType>, {
-        set: typeof set;
-        status: (statusCode: number, statusText?: string | undefined) => import("./response").ResponseTransformer<any>;
-        cookie: (name: string, value: string, options?: import("cookie").CookieSerializeOptions | undefined) => import("./response").ResponseTransformer<any>;
-        body: <BodyType extends string | Blob | ArrayBufferView | ArrayBuffer | ReadableStream<any> | FormData>(value: BodyType) => import("./response").ResponseTransformer<BodyType>;
-        text: <BodyType_1 extends string>(body: BodyType_1) => import("./response").ResponseTransformer<BodyType_1>;
-        json: <BodyTypeJSON>(body: BodyTypeJSON) => import("./response").ResponseTransformer<string>;
-        xml: <BodyType_2 extends string>(body: BodyType_2) => import("./response").ResponseTransformer<BodyType_2>;
-        delay: (durationMs?: number | undefined) => import("./response").ResponseTransformer<any>;
-        fetch: (input: string | MockedRequest<DefaultRequestBodyType, RequestParams>, requestInit?: RequestInit) => any;
-    }, ParsedRestRequest, MockedRequest<RequestBodyType, RequestParams>, ResponseBodyType>;
-    put: <RequestBodyType = DefaultRequestBodyType, ResponseBodyType = any, RequestParamsType extends RequestParams = RequestParams>(mask: Mask, resolver: ResponseResolver<MockedRequest<RequestBodyType, RequestParamsType>, {
-        set: typeof set;
-        status: (statusCode: number, statusText?: string | undefined) => import("./response").ResponseTransformer<any>;
-        cookie: (name: string, value: string, options?: import("cookie").CookieSerializeOptions | undefined) => import("./response").ResponseTransformer<any>;
-        body: <BodyType extends string | Blob | ArrayBufferView | ArrayBuffer | ReadableStream<any> | FormData>(value: BodyType) => import("./response").ResponseTransformer<BodyType>;
-        text: <BodyType_1 extends string>(body: BodyType_1) => import("./response").ResponseTransformer<BodyType_1>;
-        json: <BodyTypeJSON>(body: BodyTypeJSON) => import("./response").ResponseTransformer<string>;
-        xml: <BodyType_2 extends string>(body: BodyType_2) => import("./response").ResponseTransformer<BodyType_2>;
-        delay: (durationMs?: number | undefined) => import("./response").ResponseTransformer<any>;
-        fetch: (input: string | MockedRequest<DefaultRequestBodyType, RequestParams>, requestInit?: RequestInit) => any;
-    }, ResponseBodyType>) => RequestHandler<MockedRequest<RequestBodyType, RequestParamsType>, {
-        set: typeof set;
-        status: (statusCode: number, statusText?: string | undefined) => import("./response").ResponseTransformer<any>;
-        cookie: (name: string, value: string, options?: import("cookie").CookieSerializeOptions | undefined) => import("./response").ResponseTransformer<any>;
-        body: <BodyType extends string | Blob | ArrayBufferView | ArrayBuffer | ReadableStream<any> | FormData>(value: BodyType) => import("./response").ResponseTransformer<BodyType>;
-        text: <BodyType_1 extends string>(body: BodyType_1) => import("./response").ResponseTransformer<BodyType_1>;
-        json: <BodyTypeJSON>(body: BodyTypeJSON) => import("./response").ResponseTransformer<string>;
-        xml: <BodyType_2 extends string>(body: BodyType_2) => import("./response").ResponseTransformer<BodyType_2>;
-        delay: (durationMs?: number | undefined) => import("./response").ResponseTransformer<any>;
-        fetch: (input: string | MockedRequest<DefaultRequestBodyType, RequestParams>, requestInit?: RequestInit) => any;
-    }, ParsedRestRequest, MockedRequest<RequestBodyType, RequestParams>, ResponseBodyType>;
-    delete: <RequestBodyType = DefaultRequestBodyType, ResponseBodyType = any, RequestParamsType extends RequestParams = RequestParams>(mask: Mask, resolver: ResponseResolver<MockedRequest<RequestBodyType, RequestParamsType>, {
-        set: typeof set;
-        status: (statusCode: number, statusText?: string | undefined) => import("./response").ResponseTransformer<any>;
-        cookie: (name: string, value: string, options?: import("cookie").CookieSerializeOptions | undefined) => import("./response").ResponseTransformer<any>;
-        body: <BodyType extends string | Blob | ArrayBufferView | ArrayBuffer | ReadableStream<any> | FormData>(value: BodyType) => import("./response").ResponseTransformer<BodyType>;
-        text: <BodyType_1 extends string>(body: BodyType_1) => import("./response").ResponseTransformer<BodyType_1>;
-        json: <BodyTypeJSON>(body: BodyTypeJSON) => import("./response").ResponseTransformer<string>;
-        xml: <BodyType_2 extends string>(body: BodyType_2) => import("./response").ResponseTransformer<BodyType_2>;
-        delay: (durationMs?: number | undefined) => import("./response").ResponseTransformer<any>;
-        fetch: (input: string | MockedRequest<DefaultRequestBodyType, RequestParams>, requestInit?: RequestInit) => any;
-    }, ResponseBodyType>) => RequestHandler<MockedRequest<RequestBodyType, RequestParamsType>, {
-        set: typeof set;
-        status: (statusCode: number, statusText?: string | undefined) => import("./response").ResponseTransformer<any>;
-        cookie: (name: string, value: string, options?: import("cookie").CookieSerializeOptions | undefined) => import("./response").ResponseTransformer<any>;
-        body: <BodyType extends string | Blob | ArrayBufferView | ArrayBuffer | ReadableStream<any> | FormData>(value: BodyType) => import("./response").ResponseTransformer<BodyType>;
-        text: <BodyType_1 extends string>(body: BodyType_1) => import("./response").ResponseTransformer<BodyType_1>;
-        json: <BodyTypeJSON>(body: BodyTypeJSON) => import("./response").ResponseTransformer<string>;
-        xml: <BodyType_2 extends string>(body: BodyType_2) => import("./response").ResponseTransformer<BodyType_2>;
-        delay: (durationMs?: number | undefined) => import("./response").ResponseTransformer<any>;
-        fetch: (input: string | MockedRequest<DefaultRequestBodyType, RequestParams>, requestInit?: RequestInit) => any;
-    }, ParsedRestRequest, MockedRequest<RequestBodyType, RequestParams>, ResponseBodyType>;
-    patch: <RequestBodyType = DefaultRequestBodyType, ResponseBodyType = any, RequestParamsType extends RequestParams = RequestParams>(mask: Mask, resolver: ResponseResolver<MockedRequest<RequestBodyType, RequestParamsType>, {
-        set: typeof set;
-        status: (statusCode: number, statusText?: string | undefined) => import("./response").ResponseTransformer<any>;
-        cookie: (name: string, value: string, options?: import("cookie").CookieSerializeOptions | undefined) => import("./response").ResponseTransformer<any>;
-        body: <BodyType extends string | Blob | ArrayBufferView | ArrayBuffer | ReadableStream<any> | FormData>(value: BodyType) => import("./response").ResponseTransformer<BodyType>;
-        text: <BodyType_1 extends string>(body: BodyType_1) => import("./response").ResponseTransformer<BodyType_1>;
-        json: <BodyTypeJSON>(body: BodyTypeJSON) => import("./response").ResponseTransformer<string>;
-        xml: <BodyType_2 extends string>(body: BodyType_2) => import("./response").ResponseTransformer<BodyType_2>;
-        delay: (durationMs?: number | undefined) => import("./response").ResponseTransformer<any>;
-        fetch: (input: string | MockedRequest<DefaultRequestBodyType, RequestParams>, requestInit?: RequestInit) => any;
-    }, ResponseBodyType>) => RequestHandler<MockedRequest<RequestBodyType, RequestParamsType>, {
-        set: typeof set;
-        status: (statusCode: number, statusText?: string | undefined) => import("./response").ResponseTransformer<any>;
-        cookie: (name: string, value: string, options?: import("cookie").CookieSerializeOptions | undefined) => import("./response").ResponseTransformer<any>;
-        body: <BodyType extends string | Blob | ArrayBufferView | ArrayBuffer | ReadableStream<any> | FormData>(value: BodyType) => import("./response").ResponseTransformer<BodyType>;
-        text: <BodyType_1 extends string>(body: BodyType_1) => import("./response").ResponseTransformer<BodyType_1>;
-        json: <BodyTypeJSON>(body: BodyTypeJSON) => import("./response").ResponseTransformer<string>;
-        xml: <BodyType_2 extends string>(body: BodyType_2) => import("./response").ResponseTransformer<BodyType_2>;
-        delay: (durationMs?: number | undefined) => import("./response").ResponseTransformer<any>;
-        fetch: (input: string | MockedRequest<DefaultRequestBodyType, RequestParams>, requestInit?: RequestInit) => any;
-    }, ParsedRestRequest, MockedRequest<RequestBodyType, RequestParams>, ResponseBodyType>;
-    options: <RequestBodyType = DefaultRequestBodyType, ResponseBodyType = any, RequestParamsType extends RequestParams = RequestParams>(mask: Mask, resolver: ResponseResolver<MockedRequest<RequestBodyType, RequestParamsType>, {
-        set: typeof set;
-        status: (statusCode: number, statusText?: string | undefined) => import("./response").ResponseTransformer<any>;
-        cookie: (name: string, value: string, options?: import("cookie").CookieSerializeOptions | undefined) => import("./response").ResponseTransformer<any>;
-        body: <BodyType extends string | Blob | ArrayBufferView | ArrayBuffer | ReadableStream<any> | FormData>(value: BodyType) => import("./response").ResponseTransformer<BodyType>;
-        text: <BodyType_1 extends string>(body: BodyType_1) => import("./response").ResponseTransformer<BodyType_1>;
-        json: <BodyTypeJSON>(body: BodyTypeJSON) => import("./response").ResponseTransformer<string>;
-        xml: <BodyType_2 extends string>(body: BodyType_2) => import("./response").ResponseTransformer<BodyType_2>;
-        delay: (durationMs?: number | undefined) => import("./response").ResponseTransformer<any>;
-        fetch: (input: string | MockedRequest<DefaultRequestBodyType, RequestParams>, requestInit?: RequestInit) => any;
-    }, ResponseBodyType>) => RequestHandler<MockedRequest<RequestBodyType, RequestParamsType>, {
-        set: typeof set;
-        status: (statusCode: number, statusText?: string | undefined) => import("./response").ResponseTransformer<any>;
-        cookie: (name: string, value: string, options?: import("cookie").CookieSerializeOptions | undefined) => import("./response").ResponseTransformer<any>;
-        body: <BodyType extends string | Blob | ArrayBufferView | ArrayBuffer | ReadableStream<any> | FormData>(value: BodyType) => import("./response").ResponseTransformer<BodyType>;
-        text: <BodyType_1 extends string>(body: BodyType_1) => import("./response").ResponseTransformer<BodyType_1>;
-        json: <BodyTypeJSON>(body: BodyTypeJSON) => import("./response").ResponseTransformer<string>;
-        xml: <BodyType_2 extends string>(body: BodyType_2) => import("./response").ResponseTransformer<BodyType_2>;
-        delay: (durationMs?: number | undefined) => import("./response").ResponseTransformer<any>;
-        fetch: (input: string | MockedRequest<DefaultRequestBodyType, RequestParams>, requestInit?: RequestInit) => any;
-    }, ParsedRestRequest, MockedRequest<RequestBodyType, RequestParams>, ResponseBodyType>;
+    /**
+     * Captures a HEAD request by a given path.
+     * @example
+     * rest.head('/numbers', (req, res, ctx) => {
+     *   return res(ctx.status(302))
+     * })
+     * @see {@link https://mswjs.io/docs/api/rest `rest`}
+     */
+    head: <RequestBodyType = DefaultRequestBodyType, ResponseBodyType = any, RequestParamsType extends RequestParams = RequestParams>(mask: Mask, resolver: ResponseResolver<MockedRequest<RequestBodyType, RequestParamsType>, RestContext, ResponseBodyType>) => RequestHandler<MockedRequest<RequestBodyType, RequestParamsType>, RestContext, ParsedRestRequest, MockedRequest<RequestBodyType, RequestParams>, ResponseBodyType>;
+    /**
+     * Captures a GET request by a given path.
+     * @example
+     * rest.get('/numbers', (req, res, ctx) => {
+     *   return res(ctx.json([1, 2, 3]))
+     * })
+     * @see {@link https://mswjs.io/docs/api/rest `rest`}
+     */
+    get: <RequestBodyType = DefaultRequestBodyType, ResponseBodyType = any, RequestParamsType extends RequestParams = RequestParams>(mask: Mask, resolver: ResponseResolver<MockedRequest<RequestBodyType, RequestParamsType>, RestContext, ResponseBodyType>) => RequestHandler<MockedRequest<RequestBodyType, RequestParamsType>, RestContext, ParsedRestRequest, MockedRequest<RequestBodyType, RequestParams>, ResponseBodyType>;
+    /**
+     * Captures a POST request by a given path.
+     * @example
+     * rest.post('/numbers', (req, res, ctx) => {
+     *   return res(ctx.text('success'))
+     * })
+     * @see {@link https://mswjs.io/docs/api/rest `rest`}
+     */
+    post: <RequestBodyType = DefaultRequestBodyType, ResponseBodyType = any, RequestParamsType extends RequestParams = RequestParams>(mask: Mask, resolver: ResponseResolver<MockedRequest<RequestBodyType, RequestParamsType>, RestContext, ResponseBodyType>) => RequestHandler<MockedRequest<RequestBodyType, RequestParamsType>, RestContext, ParsedRestRequest, MockedRequest<RequestBodyType, RequestParams>, ResponseBodyType>;
+    /**
+     * Captures a PUT request by a given path.
+     * @example
+     * rest.put('/numbers', (req, res, ctx) => {
+     *   const { numbers } = req.body
+     *   return res(ctx.json(numbers))
+     * })
+     * @see {@link https://mswjs.io/docs/api/rest `rest`}
+     */
+    put: <RequestBodyType = DefaultRequestBodyType, ResponseBodyType = any, RequestParamsType extends RequestParams = RequestParams>(mask: Mask, resolver: ResponseResolver<MockedRequest<RequestBodyType, RequestParamsType>, RestContext, ResponseBodyType>) => RequestHandler<MockedRequest<RequestBodyType, RequestParamsType>, RestContext, ParsedRestRequest, MockedRequest<RequestBodyType, RequestParams>, ResponseBodyType>;
+    /**
+     * Captures a DELETE request by a given path.
+     * @example
+     * rest.delete('/numbers', (req, res, ctx) => {
+     *   const index = req.url.searchParams.get('index')
+     *   prevNumbers.splice(index, 1)
+     *   return res(ctx.json(nextNumbers))
+     * })
+     * @see {@link https://mswjs.io/docs/api/rest `rest`}
+     */
+    delete: <RequestBodyType = DefaultRequestBodyType, ResponseBodyType = any, RequestParamsType extends RequestParams = RequestParams>(mask: Mask, resolver: ResponseResolver<MockedRequest<RequestBodyType, RequestParamsType>, RestContext, ResponseBodyType>) => RequestHandler<MockedRequest<RequestBodyType, RequestParamsType>, RestContext, ParsedRestRequest, MockedRequest<RequestBodyType, RequestParams>, ResponseBodyType>;
+    /**
+     * Captures a PATCH request by a given path.
+     * @example
+     * rest.patch('/numbers', (req, res, ctx) => {
+     *   const { numbers } = req.body
+     *   const nextNumbers = prevNumbers.concat(number)
+     *   return res(ctx.json(nextNumbers))
+     * })
+     * @see {@link https://mswjs.io/docs/api/rest `rest`}
+     */
+    patch: <RequestBodyType = DefaultRequestBodyType, ResponseBodyType = any, RequestParamsType extends RequestParams = RequestParams>(mask: Mask, resolver: ResponseResolver<MockedRequest<RequestBodyType, RequestParamsType>, RestContext, ResponseBodyType>) => RequestHandler<MockedRequest<RequestBodyType, RequestParamsType>, RestContext, ParsedRestRequest, MockedRequest<RequestBodyType, RequestParams>, ResponseBodyType>;
+    /**
+     * Captures an OPTIONS request by a given path.
+     * @example
+     * rest.options('/numbers', (req, res, ctx) => {
+     *   return res(ctx.set('Allow', 'GET,HEAD,POST'))
+     * })
+     * @see {@link https://mswjs.io/docs/api/rest `rest`}
+     */
+    options: <RequestBodyType = DefaultRequestBodyType, ResponseBodyType = any, RequestParamsType extends RequestParams = RequestParams>(mask: Mask, resolver: ResponseResolver<MockedRequest<RequestBodyType, RequestParamsType>, RestContext, ResponseBodyType>) => RequestHandler<MockedRequest<RequestBodyType, RequestParamsType>, RestContext, ParsedRestRequest, MockedRequest<RequestBodyType, RequestParams>, ResponseBodyType>;
 };

package/lib/types/setupWorker/glossary.d.ts

@@ -34,17 +34,20 @@ export declare type ServiceWorkerInstanceTuple = [
 ];
 export declare type FindWorker = (scriptUrl: string, mockServiceWorkerUrl: string) => boolean;
 export declare type StartOptions = SharedOptions & {
+    /**
+     * Service Worker instance options.
+     */
     serviceWorker?: {
         url?: string;
         options?: RegistrationOptions;
     };
     /**
-     * Disable the logging of captured requests
+     * Disables the logging of captured requests
      * into browser's console.
      */
     quiet?: boolean;
     /**
-     * Defer any network requests until the Service Worker
+     * Defers any network requests until the Service Worker
      * instance is ready. Defaults to `true`.
      */
     waitUntilReady?: boolean;
@@ -59,22 +62,36 @@ export declare type ResponseWithSerializedHeaders<BodyType = any> = Omit<MockedR
     headers: HeadersList;
 };
 export interface SetupWorkerApi {
+    /**
+     * Registers and activates the mock Service Worker.
+     * @see {@link https://mswjs.io/docs/api/setup-worker/start `worker.start()`}
+     */
     start: ReturnType<typeof createStart>;
+    /**
+     * Stops requests interception for the current client.
+     * @see {@link https://mswjs.io/docs/api/setup-worker/stop `worker.stop()`}
+     */
     stop: ReturnType<typeof createStop>;
     /**
      * 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()`}
      */
     use: (...handlers: RequestHandlersList) => 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()`}
      */
     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()`}
      */
     resetHandlers: (...nextHandlers: RequestHandlersList) => void;
     /**
      * Lists all active request handlers.
+     * @see {@link https://mswjs.io/docs/api/setup-worker/print-handlers `worker.printHandlers()`}
      */
     printHandlers: () => void;
 }

package/lib/types/setupWorker/setupWorker.d.ts

@@ -1,2 +1,8 @@
 import { RequestHandlersList, SetupWorkerApi } from './glossary';
+/**
+ * Creates a new mock Service Worker registration
+ * with the given request handlers.
+ * @param {RequestHandler[]} requestHandlers List of request handlers
+ * @see {@link https://mswjs.io/docs/api/setup-worker `setupWorker`}
+ */
 export declare function setupWorker(...requestHandlers: RequestHandlersList): SetupWorkerApi;