msw 0.24.0 → 0.24.1

package/native/index.js

@@ -2315,6 +2315,13 @@ var statuses = {
 	"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;
@@ -2324,6 +2331,10 @@ const status = (statusCode, statusText) => {
     };
 };
 
+/**
+ * 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;
@@ -2367,10 +2378,11 @@ const getRandomServerResponseTime = () => {
         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) => {
@@ -2396,9 +2408,10 @@ const createFetchRequestParameters = (input) => {
     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
@@ -3979,9 +3992,6 @@ const DEFAULT_LISTEN_OPTIONS = {
  * Useful to generate identical API using different patches to request issuing modules.
  */
 function createSetupServer(...interceptors) {
-    /**
-     * Sets up a server-side requests interception with the given mock definition.
-     */
     return function setupServer(...requestHandlers) {
         requestHandlers.forEach((handler) => {
             if (Array.isArray(handler))

package/node/index.js

@@ -2317,6 +2317,13 @@ var statuses = {
 	"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;
@@ -2326,6 +2333,10 @@ const status = (statusCode, statusText) => {
     };
 };
 
+/**
+ * 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;
@@ -2369,10 +2380,11 @@ const getRandomServerResponseTime = () => {
         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) => {
@@ -2398,9 +2410,10 @@ const createFetchRequestParameters = (input) => {
     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
@@ -3981,9 +3994,6 @@ const DEFAULT_LISTEN_OPTIONS = {
  * Useful to generate identical API using different patches to request issuing modules.
  */
 function createSetupServer(...interceptors) {
-    /**
-     * Sets up a server-side requests interception with the given mock definition.
-     */
     return function setupServer(...requestHandlers) {
         requestHandlers.forEach((handler) => {
             if (Array.isArray(handler))
@@ -4083,6 +4093,11 @@ ${source.bold(meta.header)}
     };
 }
 
+/**
+ * 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`}
+ */
 const setupServer = createSetupServer(ClientRequest.interceptClientRequest, XMLHttpRequest.interceptXMLHttpRequest);
 
 exports.setupServer = setupServer;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "msw",
-  "version": "0.24.0",
+  "version": "0.24.1",
   "description": "Seamless REST/GraphQL API mocking library for browser and Node.",
   "main": "lib/umd/index.js",
   "module": "lib/esm/index.js",