msw 0.24.0 → 0.24.1

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;

package/lib/umd/index.js

@@ -70,6 +70,13 @@
   	"511": "Network Authentication Required"
   };
 
+  /**
+   * Sets a response status code and text.
+   * @example
+   * res(ctx.status(301))
+   * res(ctx.status(400, 'Custom status text'))
+   * @see {@link https://mswjs.io/docs/api/context/status `ctx.status()`}
+   */
   const status = (statusCode, statusText) => {
       return (res) => {
           res.status = statusCode;
@@ -333,6 +340,10 @@
   exports.flattenHeadersObject = flattenHeadersObject_1.flattenHeadersObject;
   });
 
+  /**
+   * Sets one or multiple response headers.
+   * @see {@link https://mswjs.io/docs/api/context/set `ctx.set()`}
+   */
   function set(...args) {
       return (res) => {
           const [name, value] = args;
@@ -551,9 +562,8 @@
   }
 
   /**
-   * Sets a given cookie on the response.
-   * @example
-   * res(cookie('name', 'value'))
+   * Sets a given cookie on the mocked response.
+   * @example res(ctx.cookie('name', 'value'))
    */
   const cookie = (name, value, options) => {
       return (res) => {
@@ -567,9 +577,11 @@
   };
 
   /**
-   * Sets the body of the response without any `Content-Type` header.
+   * Sets a raw response body. Does not append any `Content-Type` headers.
    * @example
-   * res(body('message'))
+   * res(ctx.body('Successful response'))
+   * res(ctx.body(JSON.stringify({ key: 'value' })))
+   * @see {@link https://mswjs.io/docs/api/context/body `ctx.body()`}
    */
   const body = (value) => {
       return (res) => {
@@ -620,10 +632,13 @@
 
   /**
    * Sets the given value as the JSON body of the response.
+   * Appends a `Content-Type: application/json` header on the
+   * mocked response.
    * @example
-   * res(json({ key: 'value' }))
-   * res(json('Some string'))
-   * res(json([1, '2', false, { ok: true }]))
+   * res(ctx.json('Some string'))
+   * res(ctx.json({ key: 'value' }))
+   * res(ctx.json([1, '2', false, { ok: true }]))
+   * @see {@link https://mswjs.io/docs/api/context/json `ctx.json()`}
    */
   const json = (body) => {
       return (res) => {
@@ -634,7 +649,10 @@
   };
 
   /**
-   * Returns a GraphQL body payload.
+   * Sets a given payload as a GraphQL response body.
+   * @example
+   * res(ctx.data({ user: { firstName: 'John' }}))
+   * @see {@link https://mswjs.io/docs/api/context/data `ctx.data()`}
    */
   const data = (payload) => {
       return (res) => {
@@ -671,10 +689,11 @@
           MIN_SERVER_RESPONSE_TIME);
   };
   /**
-   * Delays the current response for the given duration (in ms)
+   * Delays the response by the given duration (ms).
    * @example
-   * res(delay()) // realistic server response time
-   * res(delay(1500)) // explicit response delay duration
+   * res(ctx.delay()) // realistic server response time
+   * res(ctx.delay(1200))
+   * @see {@link https://mswjs.io/docs/api/context/delay `ctx.delay()`}
    */
   const delay = (durationMs) => {
       return (res) => {
@@ -685,6 +704,8 @@
 
   /**
    * Sets a given list of GraphQL errors on the mocked response.
+   * @example res(ctx.errors([{ message: 'Unauthorized' }]))
+   * @see {@link https://mswjs.io/docs/api/context/errors}
    */
   const errors = (errorsList) => {
       return (res) => {
@@ -714,9 +735,10 @@
       return requestParameters;
   };
   /**
-   * Wrapper around the native `window.fetch()` function that performs
-   * a request bypassing MSW. Requests performed using
-   * this function will never be mocked.
+   * Performs a bypassed request inside a request handler.
+   * @example
+   * const originalResponse = await ctx.fetch(req)
+   * @see {@link https://mswjs.io/docs/api/context/fetch `ctx.fetch()`}
    */
   const fetch = (input, requestInit = {}) => {
       // Keep the default `window.fetch()` call signature
@@ -729,9 +751,10 @@
   };
 
   /**
-   * Sets a given text as a "Cotent-Type: text/plain" body of the response.
-   * @example
-   * res(text('message'))
+   * Sets a textual response body. Appends a `Content-Type: text/plain`
+   * header on the mocked response.
+   * @example res(ctx.text('Successful response'))
+   * @see {@link https://mswjs.io/docs/api/context/text `ctx.text()`}
    */
   const text = (body) => {
       return (res) => {
@@ -742,9 +765,11 @@
   };
 
   /**
-   * Sets the given XML as the body of the response.
+   * Sets an XML response body. Appends a `Content-Type: text/xml` header
+   * on the mocked response.
    * @example
-   * res(xml('<key>value</key>'))
+   * res(ctx.xml('<node key="value">Content</node>'))
+   * @see {@link https://mswjs.io/docs/api/context/xml `ctx.xml()`}
    */
   const xml = (body) => {
       return (res) => {
@@ -2759,6 +2784,12 @@ If this message still persists after updating, please report an issue: https://g
   // Declare the list of event handlers on the module's scope
   // so it persists between Fash refreshes of the application's code.
   let listeners = [];
+  /**
+   * 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`}
+   */
   function setupWorker(...requestHandlers) {
       requestHandlers.forEach((handler) => {
           if (Array.isArray(handler))
@@ -3093,12 +3124,73 @@ ${queryParams
       };
   };
   const rest = {
+      /**
+       * 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: createRestHandler(exports.RESTMethods.HEAD),
+      /**
+       * 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: createRestHandler(exports.RESTMethods.GET),
+      /**
+       * 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: createRestHandler(exports.RESTMethods.POST),
+      /**
+       * 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: createRestHandler(exports.RESTMethods.PUT),
+      /**
+       * 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: createRestHandler(exports.RESTMethods.DELETE),
+      /**
+       * 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: createRestHandler(exports.RESTMethods.PATCH),
+      /**
+       * 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: createRestHandler(exports.RESTMethods.OPTIONS),
   };
 
@@ -6339,10 +6431,42 @@ ${queryParams
       };
   };
   const graphqlStandardHandlers = {
+      /**
+       * Captures any GraphQL operation, regardless of its name, under the current scope.
+       * @example
+       * graphql.operation((req, res, ctx) => {
+       *   return res(ctx.data({ name: 'John' }))
+       * })
+       * @see {@link https://mswjs.io/docs/api/graphql/operation `graphql.operation()`}
+       */
       operation: createGraphQLOperationHandler('*'),
+      /**
+       * Captures a GraphQL query by a given name.
+       * @example
+       * graphql.query('GetUser', (req, res, ctx) => {
+       *   return res(ctx.data({ user: { name: 'John' } }))
+       * })
+       * @see {@link https://mswjs.io/docs/api/graphql/query `graphql.query()`}
+       */
       query: createGraphQLScopedHandler('query', '*'),
+      /**
+       * Captures a GraphQL mutation by a given name.
+       * @example
+       * graphql.mutation('SavePost', (req, res, ctx) => {
+       *   return res(ctx.data({ post: { id: 'abc-123' } }))
+       * })
+       * @see {@link https://mswjs.io/docs/api/graphql/mutation `graphql.mutation()`}
+       */
       mutation: createGraphQLScopedHandler('mutation', '*'),
   };
+  /**
+   * Creates a GraphQL mocking API scoped to the given endpoint.
+   * @param uri Endpoint URL, or path.
+   * @example
+   * const api = graphql.link('https://api.site.com/graphql)
+   * api.query('GetUser', resolver)
+   * @see {@link https://mswjs.io/docs/api/graphql/link `graphql.link()`}
+   */
   function createGraphQLLink(uri) {
       return {
           operation: createGraphQLOperationHandler(uri),