msw 0.22.2 → 0.24.1

package/lib/types/context/json.d.ts

@@ -1,13 +1,12 @@
 import { ResponseTransformer } from '../response';
-declare type JSONContextOptions = {
-    merge?: boolean;
-};
 /**
  * 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()`}
  */
-export declare const json: <BodyTypeJSON>(body: BodyTypeJSON, { merge }?: JSONContextOptions) => ResponseTransformer<BodyTypeJSON>;
-export {};
+export declare const json: <BodyTypeJSON>(body: BodyTypeJSON) => ResponseTransformer<string>;

package/lib/types/context/set.d.ts

@@ -1,2 +1,6 @@
 import { ResponseTransformer } from '../response';
+/**
+ * Sets one or multiple response headers.
+ * @see {@link https://mswjs.io/docs/api/context/set `ctx.set()`}
+ */
 export declare function set<N extends string | Record<string, string | string[]>>(...args: N extends string ? [N, string] : [N]): ResponseTransformer;

package/lib/types/context/status.d.ts

@@ -1,2 +1,9 @@
 import { ResponseTransformer } from '../response';
+/**
+ * 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()`}
+ */
 export declare const status: (statusCode: number, statusText?: string | undefined) => ResponseTransformer;

package/lib/types/context/text.d.ts

@@ -1,7 +1,8 @@
 import { ResponseTransformer } from '../response';
 /**
- * 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()`}
  */
 export declare const text: <BodyType extends string>(body: BodyType) => ResponseTransformer<BodyType>;

package/lib/types/context/xml.d.ts

@@ -1,7 +1,9 @@
 import { ResponseTransformer } from '../response';
 /**
- * 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()`}
  */
 export declare const xml: <BodyType extends string>(body: BodyType) => ResponseTransformer<BodyType>;

package/lib/types/graphql.d.ts

@@ -6,7 +6,7 @@ import { set } from './context/set';
 import { status } from './context/status';
 import { delay } from './context/delay';
 import { fetch } from './context/fetch';
-import { DataContext } from './context/data';
+import { data } from './context/data';
 import { errors } from './context/errors';
 declare type GraphQLRequestHandlerSelector = RegExp | string;
 export declare type GraphQLMockedRequest<VariablesType = Record<string, any>> = Omit<MockedRequest, 'body'> & {
@@ -18,7 +18,7 @@ export interface GraphQLMockedContext<QueryType> {
     status: typeof status;
     delay: typeof delay;
     fetch: typeof fetch;
-    data: DataContext<QueryType>;
+    data: typeof data;
     errors: typeof errors;
 }
 export declare const graphqlContext: GraphQLMockedContext<any>;
@@ -33,15 +33,71 @@ export interface GraphQLRequestParsedResult<VariablesType> {
     variables: VariablesType | undefined;
 }
 declare 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: <QueryType, VariablesType = Record<string, any>>(resolver: GraphQLResponseResolver<QueryType, VariablesType>) => RequestHandler<GraphQLMockedRequest<VariablesType>, GraphQLMockedContext<QueryType>, GraphQLRequestParsedResult<VariablesType>, GraphQLMockedRequest<VariablesType>, any>;
+    /**
+     * 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: <QueryType_1, VariablesType_1 = Record<string, any>>(expectedOperationName: GraphQLRequestHandlerSelector, resolver: GraphQLResponseResolver<QueryType_1, VariablesType_1>) => RequestHandler<GraphQLMockedRequest<VariablesType_1>, GraphQLMockedContext<QueryType_1>, GraphQLRequestParsedResult<VariablesType_1>, GraphQLMockedRequest<VariablesType_1>, any>;
+    /**
+     * 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: <QueryType_1, VariablesType_1 = Record<string, any>>(expectedOperationName: GraphQLRequestHandlerSelector, resolver: GraphQLResponseResolver<QueryType_1, VariablesType_1>) => RequestHandler<GraphQLMockedRequest<VariablesType_1>, GraphQLMockedContext<QueryType_1>, GraphQLRequestParsedResult<VariablesType_1>, GraphQLMockedRequest<VariablesType_1>, any>;
 };
+/**
+ * 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()`}
+ */
 declare function createGraphQLLink(uri: Mask): typeof graphqlStandardHandlers;
 export declare const graphql: {
     link: typeof createGraphQLLink;
+    /**
+     * 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: <QueryType, VariablesType = Record<string, any>>(resolver: GraphQLResponseResolver<QueryType, VariablesType>) => RequestHandler<GraphQLMockedRequest<VariablesType>, GraphQLMockedContext<QueryType>, GraphQLRequestParsedResult<VariablesType>, GraphQLMockedRequest<VariablesType>, any>;
+    /**
+     * 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: <QueryType_1, VariablesType_1 = Record<string, any>>(expectedOperationName: GraphQLRequestHandlerSelector, resolver: GraphQLResponseResolver<QueryType_1, VariablesType_1>) => RequestHandler<GraphQLMockedRequest<VariablesType_1>, GraphQLMockedContext<QueryType_1>, GraphQLRequestParsedResult<VariablesType_1>, GraphQLMockedRequest<VariablesType_1>, any>;
+    /**
+     * 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: <QueryType_1, VariablesType_1 = Record<string, any>>(expectedOperationName: GraphQLRequestHandlerSelector, resolver: GraphQLResponseResolver<QueryType_1, VariablesType_1>) => RequestHandler<GraphQLMockedRequest<VariablesType_1>, GraphQLMockedContext<QueryType_1>, GraphQLRequestParsedResult<VariablesType_1>, GraphQLMockedRequest<VariablesType_1>, any>;
 };
 export {};

package/lib/types/index.d.ts

@@ -3,7 +3,8 @@ export { setupWorker } from './setupWorker/setupWorker';
 export { SetupWorkerApi } from './setupWorker/glossary';
 export { response, defaultResponse, createResponseComposition, MockedResponse, ResponseTransformer, ResponseComposition, ResponseCompositionOptions, ResponseFunction, } from './response';
 export { context };
-export { MockedRequest, RequestHandler, RequestParams, RequestQuery, ResponseResolver, ResponseResolverReturnType, AsyncResponseResolverReturnType, defaultContext, } from './utils/handlers/requestHandler';
+export { defaultContext, MockedRequest, RequestHandler, RequestHandlerMetaInfo, RequestParams, RequestQuery, ResponseResolver, ResponseResolverReturnType, AsyncResponseResolverReturnType, } from './utils/handlers/requestHandler';
 export { rest, restContext, RESTMethods, ParsedRestRequest } from './rest';
 export { graphql, graphqlContext, GraphQLMockedRequest, GraphQLMockedContext, GraphQLRequestPayload, GraphQLResponseResolver, GraphQLRequestParsedResult, } from './graphql';
 export { matchRequestUrl } from './utils/matching/matchRequestUrl';
+export { compose } from './utils/internal/compose';

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

@@ -2,23 +2,33 @@ import { SharedOptions } from '../sharedOptions';
 import { RequestHandlersList } from '../setupWorker/glossary';
 export interface SetupServerApi {
     /**
-     * Enables requests interception based on the previously provided mock definition.
+     * Starts requests interception based on the previously provided request handlers.
+     * @see {@link https://mswjs.io/docs/api/setup-server/listen `server.listen()`}
      */
     listen: (options?: SharedOptions) => void;
+    /**
+     * Stops requests interception by restoring all augmented modules.
+     * @see {@link https://mswjs.io/docs/api/setup-server/close `server.close()`}
+     */
+    close: () => void;
     /**
      * Prepends given request handlers to the list of existing handlers.
+     * @see {@link https://mswjs.io/docs/api/setup-server/use `server.use()`}
      */
     use: (...handlers: RequestHandlersList) => 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()`}
      */
     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()`}
      */
     resetHandlers: (...nextHandlers: RequestHandlersList) => void;
     /**
-     * Stops requests interception by restoring all augmented modules.
+     * Lists all active request handlers.
+     * @see {@link https://mswjs.io/docs/api/setup-server/print-handlers `server.print-handlers()`}
      */
-    close: () => void;
+    printHandlers: () => void;
 }

package/lib/types/node/setupServer.d.ts

@@ -1 +1,6 @@
+/**
+ * Sets up a requests interception in NodeJS with the given request handlers.
+ * @param {RequestHandler[]} requestHandlers List of request handlers.
+ * @see {@link https://mswjs.io/docs/api/setup-server `setupServer`}
+ */
 export declare const setupServer: (...requestHandlers: import("../setupWorker/glossary").RequestHandlersList) => import("./glossary").SetupServerApi;

package/lib/types/response.d.ts

@@ -1,4 +1,7 @@
 import { Headers } from 'headers-utils';
+/**
+ * Internal representation of a mocked response instance.
+ */
 export interface MockedResponse<BodyType = any> {
     body: BodyType;
     status: number;
@@ -7,8 +10,8 @@ export interface MockedResponse<BodyType = any> {
     once: boolean;
     delay?: number;
 }
-export declare type ResponseTransformer<BodyType = any> = (res: MockedResponse<BodyType>) => MockedResponse<BodyType>;
-export declare type ResponseFunction<BodyType = any> = (...transformers: ResponseTransformer<BodyType>[]) => MockedResponse<BodyType>;
+export declare type ResponseTransformer<BodyType = any> = (res: MockedResponse<BodyType>) => MockedResponse<BodyType> | Promise<MockedResponse<BodyType>>;
+export declare type ResponseFunction<BodyType = any> = (...transformers: ResponseTransformer<BodyType>[]) => MockedResponse<BodyType> | Promise<MockedResponse<BodyType>>;
 export declare type ResponseComposition<BodyType = any> = ResponseFunction<BodyType> & {
     /**
      * Respond using a given mocked response to the first captured request.

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,196 +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, { merge }?: {
-        merge?: boolean | undefined;
-    }) => import("./response").ResponseTransformer<BodyTypeJSON>;
-    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, { merge }?: {
-            merge?: boolean | undefined;
-        }) => import("./response").ResponseTransformer<BodyTypeJSON>;
-        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, { merge }?: {
-            merge?: boolean | undefined;
-        }) => import("./response").ResponseTransformer<BodyTypeJSON>;
-        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, { merge }?: {
-            merge?: boolean | undefined;
-        }) => import("./response").ResponseTransformer<BodyTypeJSON>;
-        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, { merge }?: {
-            merge?: boolean | undefined;
-        }) => import("./response").ResponseTransformer<BodyTypeJSON>;
-        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, { merge }?: {
-            merge?: boolean | undefined;
-        }) => import("./response").ResponseTransformer<BodyTypeJSON>;
-        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, { merge }?: {
-            merge?: boolean | undefined;
-        }) => import("./response").ResponseTransformer<BodyTypeJSON>;
-        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, { merge }?: {
-            merge?: boolean | undefined;
-        }) => import("./response").ResponseTransformer<BodyTypeJSON>;
-        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, { merge }?: {
-            merge?: boolean | undefined;
-        }) => import("./response").ResponseTransformer<BodyTypeJSON>;
-        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, { merge }?: {
-            merge?: boolean | undefined;
-        }) => import("./response").ResponseTransformer<BodyTypeJSON>;
-        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, { merge }?: {
-            merge?: boolean | undefined;
-        }) => import("./response").ResponseTransformer<BodyTypeJSON>;
-        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, { merge }?: {
-            merge?: boolean | undefined;
-        }) => import("./response").ResponseTransformer<BodyTypeJSON>;
-        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, { merge }?: {
-            merge?: boolean | undefined;
-        }) => import("./response").ResponseTransformer<BodyTypeJSON>;
-        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, { merge }?: {
-            merge?: boolean | undefined;
-        }) => import("./response").ResponseTransformer<BodyTypeJSON>;
-        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, { merge }?: {
-            merge?: boolean | undefined;
-        }) => import("./response").ResponseTransformer<BodyTypeJSON>;
-        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,18 +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;