@zimic/interceptor 0.16.0-canary.5 → 0.16.0-canary.6

package/package.json

@@ -14,7 +14,7 @@
     "api",
     "static"
   ],
-  "version": "0.16.0-canary.5",
+  "version": "0.16.0-canary.6",
   "repository": {
     "type": "git",
     "url": "https://github.com/zimicjs/zimic.git",
@@ -98,9 +98,9 @@
     "typescript": "^5.8.2",
     "vitest": "^3.0.8",
     "@zimic/lint-staged-config": "0.0.0",
-    "@zimic/utils": "0.0.0",
     "@zimic/eslint-config-node": "0.0.0",
-    "@zimic/tsconfig": "0.0.0"
+    "@zimic/tsconfig": "0.0.0",
+    "@zimic/utils": "0.0.0"
   },
   "peerDependencies": {
     "@zimic/http": "^0.1.0 || ^0.1.0-canary.0",

package/src/http/interceptor/HttpInterceptorClient.ts

@@ -23,13 +23,17 @@ import RemoteHttpRequestHandler from '../requestHandler/RemoteHttpRequestHandler
 import { HttpRequestHandler, InternalHttpRequestHandler } from '../requestHandler/types/public';
 import { HttpInterceptorRequest } from '../requestHandler/types/requests';
 import NotRunningHttpInterceptorError from './errors/NotRunningHttpInterceptorError';
+import RequestSavingSafeLimitExceededError from './errors/RequestSavingSafeLimitExceededError';
 import RunningHttpInterceptorError from './errors/RunningHttpInterceptorError';
 import HttpInterceptorStore from './HttpInterceptorStore';
 import { UnhandledRequestStrategy } from './types/options';
+import { HttpInterceptorRequestSaving } from './types/public';
 import { HttpInterceptorRequestContext } from './types/requests';
 
 export const SUPPORTED_BASE_URL_PROTOCOLS = Object.freeze(['http', 'https']);
 
+export const DEFAULT_REQUEST_SAVING_SAFE_LIMIT = 1000;
+
 class HttpInterceptorClient<
   Schema extends HttpSchema,
   HandlerConstructor extends HttpRequestHandlerConstructor = HttpRequestHandlerConstructor,
@@ -38,7 +42,9 @@ class HttpInterceptorClient<
   private store: HttpInterceptorStore;
 
   private _baseURL!: URL;
-  private _saveRequests?: boolean;
+
+  requestSaving: HttpInterceptorRequestSaving;
+  private numberOfSavedRequests = 0;
 
   onUnhandledRequest?: HandlerConstructor extends typeof LocalHttpRequestHandler
     ? UnhandledRequestStrategy.Local
@@ -64,7 +70,7 @@ class HttpInterceptorClient<
     worker: HttpInterceptorWorker;
     store: HttpInterceptorStore;
     baseURL: URL;
-    saveRequests?: boolean;
+    requestSaving?: Partial<HttpInterceptorRequestSaving>;
     onUnhandledRequest?: UnhandledRequestStrategy;
     Handler: HandlerConstructor;
   }) {
@@ -72,7 +78,12 @@ class HttpInterceptorClient<
     this.store = options.store;
 
     this.baseURL = options.baseURL;
-    this._saveRequests = options.saveRequests;
+
+    this.requestSaving = {
+      enabled: options.requestSaving?.enabled ?? (isServerSide() ? process.env.NODE_ENV === 'test' : false),
+      safeLimit: options.requestSaving?.safeLimit ?? DEFAULT_REQUEST_SAVING_SAFE_LIMIT,
+    };
+
     this.onUnhandledRequest = options.onUnhandledRequest satisfies
       | UnhandledRequestStrategy
       | undefined as this['onUnhandledRequest'];
@@ -103,17 +114,6 @@ class HttpInterceptorClient<
     return this.baseURL.href;
   }
 
-  get saveRequests() {
-    if (this._saveRequests === undefined) {
-      return isServerSide() ? process.env.NODE_ENV === 'test' : false;
-    }
-    return this._saveRequests;
-  }
-
-  set saveRequests(saveRequests: boolean) {
-    this._saveRequests = saveRequests;
-  }
-
   get platform() {
     return this.worker.platform;
   }
@@ -251,7 +251,7 @@ class HttpInterceptorClient<
     const responseDeclaration = await matchedHandler.applyResponseDeclaration(parsedRequest);
     const response = HttpInterceptorWorker.createResponseFromDeclaration(request, responseDeclaration);
 
-    if (this.saveRequests) {
+    if (this.requestSaving.enabled) {
       const responseClone = response.clone();
 
       const parsedResponse = await HttpInterceptorWorker.parseRawResponse<
@@ -265,6 +265,17 @@ class HttpInterceptorClient<
     return response;
   }
 
+  incrementNumberOfSavedRequests(increment: number) {
+    this.numberOfSavedRequests = Math.max(this.numberOfSavedRequests + increment, 0);
+
+    const exceedsSafeLimit = this.numberOfSavedRequests > this.requestSaving.safeLimit;
+
+    if (increment > 0 && exceedsSafeLimit) {
+      const error = new RequestSavingSafeLimitExceededError(this.numberOfSavedRequests, this.requestSaving.safeLimit);
+      console.warn(error);
+    }
+  }
+
   private async findMatchedHandler<
     Method extends HttpSchemaMethod<Schema>,
     Path extends HttpSchemaPath<Schema, Method>,

package/src/http/interceptor/LocalHttpInterceptor.ts

@@ -4,8 +4,8 @@ import LocalHttpRequestHandler from '../requestHandler/LocalHttpRequestHandler';
 import HttpInterceptorClient from './HttpInterceptorClient';
 import HttpInterceptorStore from './HttpInterceptorStore';
 import { SyncHttpInterceptorMethodHandler } from './types/handlers';
-import { LocalHttpInterceptorOptions } from './types/options';
-import { LocalHttpInterceptor as PublicLocalHttpInterceptor } from './types/public';
+import { LocalHttpInterceptorOptions, UnhandledRequestStrategy } from './types/options';
+import { HttpInterceptorRequestSaving, LocalHttpInterceptor as PublicLocalHttpInterceptor } from './types/public';
 
 class LocalHttpInterceptor<Schema extends HttpSchema> implements PublicLocalHttpInterceptor<Schema> {
   private store = new HttpInterceptorStore();
@@ -23,7 +23,7 @@ class LocalHttpInterceptor<Schema extends HttpSchema> implements PublicLocalHttp
       baseURL,
       Handler: LocalHttpRequestHandler,
       onUnhandledRequest: options.onUnhandledRequest,
-      saveRequests: options.saveRequests,
+      requestSaving: options.requestSaving,
     });
   }
 
@@ -39,19 +39,19 @@ class LocalHttpInterceptor<Schema extends HttpSchema> implements PublicLocalHttp
     this.client.baseURL = new URL(baseURL);
   }
 
-  get saveRequests() {
-    return this.client.saveRequests;
+  get requestSaving() {
+    return this.client.requestSaving;
   }
 
-  set saveRequests(saveRequests: NonNullable<LocalHttpInterceptorOptions['saveRequests']>) {
-    this.client.saveRequests = saveRequests;
+  set requestSaving(requestSaving: HttpInterceptorRequestSaving) {
+    this.client.requestSaving = requestSaving;
   }
 
   get onUnhandledRequest() {
     return this.client.onUnhandledRequest;
   }
 
-  set onUnhandledRequest(onUnhandledRequest: LocalHttpInterceptorOptions['onUnhandledRequest']) {
+  set onUnhandledRequest(onUnhandledRequest: UnhandledRequestStrategy.Local | undefined) {
     this.client.onUnhandledRequest = onUnhandledRequest;
   }
 

package/src/http/interceptor/RemoteHttpInterceptor.ts

@@ -4,8 +4,8 @@ import RemoteHttpRequestHandler from '../requestHandler/RemoteHttpRequestHandler
 import HttpInterceptorClient from './HttpInterceptorClient';
 import HttpInterceptorStore from './HttpInterceptorStore';
 import { AsyncHttpInterceptorMethodHandler } from './types/handlers';
-import { RemoteHttpInterceptorOptions } from './types/options';
-import { RemoteHttpInterceptor as PublicRemoteHttpInterceptor } from './types/public';
+import { RemoteHttpInterceptorOptions, UnhandledRequestStrategy } from './types/options';
+import { HttpInterceptorRequestSaving, RemoteHttpInterceptor as PublicRemoteHttpInterceptor } from './types/public';
 
 class RemoteHttpInterceptor<Schema extends HttpSchema> implements PublicRemoteHttpInterceptor<Schema> {
   private store = new HttpInterceptorStore();
@@ -24,7 +24,7 @@ class RemoteHttpInterceptor<Schema extends HttpSchema> implements PublicRemoteHt
       baseURL,
       Handler: RemoteHttpRequestHandler,
       onUnhandledRequest: options.onUnhandledRequest,
-      saveRequests: options.saveRequests,
+      requestSaving: options.requestSaving,
     });
   }
 
@@ -40,19 +40,19 @@ class RemoteHttpInterceptor<Schema extends HttpSchema> implements PublicRemoteHt
     this.client.baseURL = new URL(baseURL);
   }
 
-  get saveRequests() {
-    return this.client.saveRequests;
+  get requestSaving() {
+    return this.client.requestSaving;
   }
 
-  set saveRequests(saveRequests: NonNullable<RemoteHttpInterceptorOptions['saveRequests']>) {
-    this.client.saveRequests = saveRequests;
+  set requestSaving(requestSaving: HttpInterceptorRequestSaving) {
+    this.client.requestSaving = requestSaving;
   }
 
   get onUnhandledRequest() {
     return this.client.onUnhandledRequest;
   }
 
-  set onUnhandledRequest(onUnhandledRequest: RemoteHttpInterceptorOptions['onUnhandledRequest']) {
+  set onUnhandledRequest(onUnhandledRequest: UnhandledRequestStrategy.Remote | undefined) {
     this.client.onUnhandledRequest = onUnhandledRequest;
   }
 

package/src/http/interceptor/errors/RequestSavingSafeLimitExceededError.ts

@@ -0,0 +1,22 @@
+/**
+ * Error thrown when the safe limit of saved intercepted requests is exceeded.
+ *
+ * @see {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#saving-requests Saving intercepted requests}
+ */
+class RequestSavingSafeLimitExceededError extends TypeError {
+  constructor(numberOfSavedRequests: number, safeLimit: number) {
+    super(
+      `The number of intercepted requests saved in memory (${numberOfSavedRequests}) exceeded the safe limit of ` +
+        `${safeLimit}. Did you forget to call \`interceptor.clear()\`?\n\n` +
+        'If you need to save requests, make sure to regularly call `interceptor.clear()`. Alternatively, you can ' +
+        'hide this warning by increasing `requestSaving.safeLimit` in your interceptor. Note that saving too many ' +
+        'requests in memory can lead to performance issues.\n\n' +
+        'If you do not need to save requests, consider setting `requestSaving.enabled: false` in your ' +
+        'interceptor.\n\n' +
+        'Learn more: https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#saving-requests',
+    );
+    this.name = 'RequestSavingSafeLimitExceededError';
+  }
+}
+
+export default RequestSavingSafeLimitExceededError;

package/src/http/interceptor/types/options.ts

@@ -1,5 +1,6 @@
 import { PossiblePromise } from '@zimic/utils/types';
 
+import { HttpInterceptorRequestSaving } from './public';
 import { UnhandledHttpInterceptorRequest } from './requests';
 
 /**
@@ -119,20 +120,12 @@ export interface SharedHttpInterceptorOptions {
   baseURL: string;
 
   /**
-   * Whether {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#httprequesthandler request handlers}
-   * should save their intercepted requests in memory and make them accessible through
-   * {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#http-handlerrequests `handler.requests`}.
+   * Configures if the intercepted requests are saved and how they are handled.
    *
-   * **Important**: If `saveRequests` is true, make sure to regularly clear the interceptor to avoid that the requests
-   * accumulate in memory. A common practice is to call
-   * {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#http-interceptorclear `interceptor.clear()`}
-   * after each test.
-   *
-   * @default false
    * @see {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#saving-requests Saving intercepted requests}
    * @see {@link https://github.com/zimicjs/zimic/wiki/guides‐testing‐interceptor Testing}
    */
-  saveRequests?: boolean;
+  requestSaving?: Partial<HttpInterceptorRequestSaving>;
 }
 
 /**

package/src/http/interceptor/types/public.ts

@@ -3,6 +3,45 @@ import { HttpSchema } from '@zimic/http';
 import { SyncHttpInterceptorMethodHandler, AsyncHttpInterceptorMethodHandler } from './handlers';
 import { HttpInterceptorPlatform, UnhandledRequestStrategy } from './options';
 
+/**
+ * Configures if the intercepted requests are saved and how they are handled.
+ *
+ * @see {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#saving-requests Saving intercepted requests}
+ * @see {@link https://github.com/zimicjs/zimic/wiki/guides‐testing‐interceptor Testing}
+ */
+export interface HttpInterceptorRequestSaving {
+  /**
+   * Whether {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#httprequesthandler request handlers}
+   * should save their intercepted requests in memory and make them accessible through
+   * {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#http-handlerrequests `handler.requests`}.
+   *
+   * If you are using
+   * {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#http-interceptorchecktimes `interceptor.checkTimes()`}
+   * or
+   * {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#http-handlerchecktimes `handler.checkTimes()`}
+   * during tests, consider enabling this option to get more detailed information in `TimesCheckError` errors.
+   *
+   * **Important**: If `requestSaving.enabled` is `true`, make sure to regularly clear the interceptor to avoid requests
+   * accumulating in memory. A common practice is to call
+   * {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#http-interceptorclear `interceptor.clear()`}
+   * after each test.
+   *
+   * @default process.env.NODE_ENV === 'test'
+   */
+  enabled: boolean;
+
+  /**
+   * The safe number of requests to save in memory before logging warnings in the console. If `requestSaving.enabled` is
+   * `true` and the interceptor is not regularly cleared with
+   * {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#http-interceptorclear `interceptor.clear()`},
+   * the requests may accumulate in memory and cause performance issues. This option does not limit the number of
+   * requests saved in memory, only when to log warnings.
+   *
+   * @default 1000
+   */
+  safeLimit: number;
+}
+
 /**
  * An interceptor to handle HTTP requests and return mock responses. The methods, paths, status codes, parameters, and
  * responses are statically-typed based on the provided service schema.
@@ -20,20 +59,12 @@ export interface HttpInterceptor<_Schema extends HttpSchema> {
   baseURL: string;
 
   /**
-   * Whether {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#httprequesthandler request handlers}
-   * should save their intercepted requests in memory and make them accessible through
-   * {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#http-handlerrequests `handler.requests`}.
-   *
-   * **Important**: If `saveRequests` is true, make sure to regularly clear the interceptor to avoid that the requests
-   * accumulate in memory. A common practice is to call
-   * {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#http-interceptorclear `interceptor.clear()`}
-   * after each test.
+   * Configures if the intercepted requests are saved and how they are handled.
    *
-   * @default process.env.NODE_ENV === 'test'
    * @see {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#saving-requests Saving intercepted requests}
    * @see {@link https://github.com/zimicjs/zimic/wiki/guides‐testing‐interceptor Testing}
    */
-  saveRequests: boolean;
+  requestSaving: HttpInterceptorRequestSaving;
 
   /**
    * The platform the interceptor is running on.
@@ -86,8 +117,9 @@ export interface HttpInterceptor<_Schema extends HttpSchema> {
    * of each test.
    *
    * When
-   * {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#createhttpinterceptoroptions `saveRequests: true`}
-   * is enabled in your interceptor, the `TimesCheckError` errors will also list each unmatched request with diff of the
+   * {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#saving-requests
+   * `requestSaving.enabled`} is
+   * `true` in your interceptor, the `TimesCheckError` errors will also list each unmatched request with diff of the
    * expected and received data. This is useful for debugging requests that did not match a handler with
    * {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#http-handlerwithrestriction restrictions}.
    *

package/src/http/requestHandler/HttpRequestHandlerClient.ts

@@ -91,7 +91,8 @@ class HttpRequestHandlerClient<
 
     newThis.numberOfMatchedRequests = 0;
     newThis.unmatchedRequestGroups.length = 0;
-    newThis._requests.length = 0;
+
+    newThis.clearInterceptedRequests();
 
     this.interceptor.registerRequestHandler(this.handler);
 
@@ -132,7 +133,7 @@ class HttpRequestHandlerClient<
         declarationPointer: this.timesDeclarationPointer,
         unmatchedRequestGroups: this.unmatchedRequestGroups,
         hasRestrictions: this.restrictions.length > 0,
-        hasSavedRequests: this.interceptor.saveRequests,
+        requestSaving: this.interceptor.requestSaving,
       });
     }
   }
@@ -148,7 +149,8 @@ class HttpRequestHandlerClient<
 
     this.numberOfMatchedRequests = 0;
     this.unmatchedRequestGroups.length = 0;
-    this._requests.length = 0;
+
+    this.clearInterceptedRequests();
 
     this.createResponseDeclaration = undefined;
 
@@ -168,7 +170,9 @@ class HttpRequestHandlerClient<
       this.numberOfMatchedRequests++;
     } else {
       const shouldSaveUnmatchedGroup =
-        this.interceptor.saveRequests && this.restrictions.length > 0 && this.timesDeclarationPointer !== undefined;
+        this.interceptor.requestSaving.enabled &&
+        this.restrictions.length > 0 &&
+        this.timesDeclarationPointer !== undefined;
 
       if (shouldSaveUnmatchedGroup) {
         this.unmatchedRequestGroups.push({ request, diff: restrictionsMatch.diff });
@@ -378,6 +382,12 @@ class HttpRequestHandlerClient<
   ) {
     const interceptedRequest = this.createInterceptedRequest(request, response);
     this._requests.push(interceptedRequest);
+    this.interceptor.incrementNumberOfSavedRequests(1);
+  }
+
+  private clearInterceptedRequests() {
+    this.interceptor.incrementNumberOfSavedRequests(-this._requests.length);
+    this._requests.length = 0;
   }
 
   private createInterceptedRequest(
@@ -401,7 +411,7 @@ class HttpRequestHandlerClient<
   }
 
   get requests(): readonly InterceptedHttpInterceptorRequest<Path, Default<Schema[Path][Method]>, StatusCode>[] {
-    if (!this.interceptor.saveRequests) {
+    if (!this.interceptor.requestSaving.enabled) {
       throw new DisabledRequestSavingError();
     }
 

package/src/http/requestHandler/errors/DisabledRequestSavingError.ts

@@ -7,7 +7,7 @@ class DisabledRequestSavingError extends TypeError {
   constructor() {
     super(
       'Intercepted requests are not being saved. ' +
-        'Did you forget to use `saveRequests: true` when creating the interceptor?\n\n' +
+        'Did you forget to use `requestSaving.enabled: true` in your interceptor?\n\n' +
         'Learn more: https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#saving-requests',
     );
     this.name = 'DisabledRequestSavingError';

package/src/http/requestHandler/errors/TimesCheckError.ts

@@ -2,6 +2,7 @@ import isNonEmpty from '@zimic/utils/data/isNonEmpty';
 import { Range } from '@zimic/utils/types';
 import chalk from 'chalk';
 
+import { HttpInterceptorRequestSaving } from '@/http/interceptor/types/public';
 import { stringifyValueToLog } from '@/utils/console';
 
 import { UnmatchedHttpInterceptorRequestGroup } from '../types/restrictions';
@@ -13,7 +14,7 @@ interface TimesCheckErrorOptions {
   declarationPointer: TimesDeclarationPointer | undefined;
   unmatchedRequestGroups: UnmatchedHttpInterceptorRequestGroup[];
   hasRestrictions: boolean;
-  hasSavedRequests: boolean;
+  requestSaving: HttpInterceptorRequestSaving;
 }
 
 function createMessageHeader({
@@ -51,9 +52,9 @@ function createMessageHeader({
     .join('');
 }
 
-function createMessageDiffs({ hasSavedRequests, unmatchedRequestGroups }: TimesCheckErrorOptions) {
-  if (!hasSavedRequests) {
-    return 'Tip: enable `saveRequests: true` in your interceptor for more details about the unmatched requests.';
+function createMessageDiffs({ requestSaving, unmatchedRequestGroups }: TimesCheckErrorOptions) {
+  if (!requestSaving.enabled) {
+    return 'Tip: use `requestSaving.enabled: true` in your interceptor for more details about the unmatched requests.';
   }
 
   return unmatchedRequestGroups

package/src/http/requestHandler/types/public.ts

@@ -147,8 +147,9 @@ export interface LocalHttpRequestHandler<
    * that was not satisfied.
    *
    * When
-   * {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#createhttpinterceptoroptions `saveRequests: true`}
-   * is enabled in your interceptor, the `TimesCheckError` errors will also list each unmatched request with diff of the
+   * {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#saving-requests
+   * `requestSaving.enabled`} is
+   * `true` in your interceptor, the `TimesCheckError` errors will also list each unmatched request with diff of the
    * expected and received data. This is useful for debugging requests that did not match a handler with
    * {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#http-handlerwithrestriction restrictions}.
    *
@@ -178,11 +179,14 @@ export interface LocalHttpRequestHandler<
    * The intercepted requests that matched this handler, along with the responses returned to each of them. This is
    * useful for testing that the correct requests were made by your application.
    *
-   * **Important**: This method can only be used if `saveRequests` was set to `true` when creating the interceptor. See
+   * **Important**: This method can only be used if
+   * {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#saving-requests
+   * `requestSaving.enabled`} is
+   * `true` in the interceptor. See
    * {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#saving-requests Saving intercepted requests}
    * for more information.
    *
-   * @throws {DisabledRequestSavingError} If the interceptor was not created with `saveRequests: true`.
+   * @throws {DisabledRequestSavingError} If the interceptor has `requestSaving.enabled: false`.
    * @readonly
    * @see {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#http-handlerrequests `handler.requests` API reference}
    */
@@ -284,8 +288,9 @@ export interface SyncedRemoteHttpRequestHandler<
    * that was not satisfied.
    *
    * When
-   * {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#createhttpinterceptoroptions `saveRequests: true`}
-   * is enabled in your interceptor, the `TimesCheckError` errors will also list each unmatched request with diff of the
+   * {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#saving-requests
+   * `requestSaving.enabled`} is
+   * true in your interceptor, the `TimesCheckError` errors will also list each unmatched request with diff of the
    * expected and received data. This is useful for debugging requests that did not match a handler with
    * {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#http-handlerwithrestriction restrictions}.
    *
@@ -315,11 +320,14 @@ export interface SyncedRemoteHttpRequestHandler<
    * The intercepted requests that matched this handler, along with the responses returned to each of them. This is
    * useful for testing that the correct requests were made by your application.
    *
-   * **Important**: This method can only be used if `saveRequests` was set to `true` when creating the interceptor. See
+   * **Important**: This method can only be used if
+   * {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#saving-requests
+   * `requestSaving.enabled`} is
+   * `true` in the interceptor. See
    * {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#saving-requests Saving intercepted requests}
    * for more information.
    *
-   * @throws {DisabledRequestSavingError} If the interceptor was not created with `saveRequests: true`.
+   * @throws {DisabledRequestSavingError} If the interceptor has `requestSaving.enabled: false`.
    * @readonly
    * @see {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#http-handlerrequests `handler.requests` API reference}
    */