@zimic/interceptor 0.19.1-canary.6 → 0.19.1-canary.8

package/dist/http.d.ts

@@ -114,21 +114,13 @@ type HttpRequestHandlerResponseDeclarationWithHeaders<ResponseSchema extends Htt
 } : {
     headers: HttpRequestHandlerResponseDeclarationHeaders<ResponseSchema>;
 };
-/** A declaration of an HTTP response for an intercepted request. */
+/** @see {@link https://zimic.dev/docs/interceptor/api/http-request-handler#handlerrespond `handler.respond()` API reference} */
 type HttpRequestHandlerResponseDeclaration<MethodSchema extends HttpMethodSchema = HttpMethodSchema, StatusCode extends HttpStatusCode = HttpStatusCode> = StatusCode extends StatusCode ? {
     status: StatusCode;
 } & HttpRequestHandlerResponseWithBody<Default<Default<MethodSchema['response']>[StatusCode]>, StatusCode> & HttpRequestHandlerResponseDeclarationWithHeaders<Default<Default<MethodSchema['response']>[StatusCode]>> : never;
-/**
- * A factory to create {@link HttpRequestHandlerResponseDeclaration} objects.
- *
- * @param request The intercepted request.
- * @returns The response declaration.
- */
+/** @see {@link https://zimic.dev/docs/interceptor/api/http-request-handler#handlerrespond `handler.respond()` API reference} */
 type HttpRequestHandlerResponseDeclarationFactory<Path extends string, MethodSchema extends HttpMethodSchema, StatusCode extends HttpStatusCode = HttpStatusCode> = (request: Omit<HttpInterceptorRequest<Path, MethodSchema>, 'response'>) => PossiblePromise<HttpRequestHandlerResponseDeclaration<MethodSchema, StatusCode>>;
-/**
- * A strict representation of an intercepted HTTP request. The body, search params and path params are already parsed by
- * default.
- */
+/** @see {@link https://zimic.dev/docs/interceptor/api/http-request-handler#handlerrequests `handler.requests` API reference} */
 interface HttpInterceptorRequest<Path extends string, MethodSchema extends HttpMethodSchema> extends Omit<HttpRequest, keyof Body | 'headers' | 'clone'> {
     /** The headers of the request. */
     headers: HttpHeaders<Default<HttpRequestHeadersSchema<MethodSchema>>>;
@@ -141,10 +133,7 @@ interface HttpInterceptorRequest<Path extends string, MethodSchema extends HttpM
     /** The raw request object. */
     raw: HttpRequest<HttpRequestBodySchema<MethodSchema>, Default<HttpRequestHeadersSchema<MethodSchema>>>;
 }
-/**
- * A strict representation of an intercepted HTTP response. The body, search params and path params are already parsed
- * by default.
- */
+/** @see {@link https://zimic.dev/docs/interceptor/api/http-request-handler#handlerrequests `handler.requests` API reference} */
 interface HttpInterceptorResponse<MethodSchema extends HttpMethodSchema, StatusCode extends HttpStatusCode> extends Omit<HttpResponse, keyof Body | 'headers' | 'clone'> {
     /** The headers of the response. */
     headers: HttpHeaders<Default<HttpResponseHeadersSchema<MethodSchema, StatusCode>>>;
@@ -155,10 +144,7 @@ interface HttpInterceptorResponse<MethodSchema extends HttpMethodSchema, StatusC
     /** The raw response object. */
     raw: HttpResponse<HttpResponseBodySchema<MethodSchema, StatusCode>, Default<HttpResponseHeadersSchema<MethodSchema, StatusCode>>, StatusCode>;
 }
-/**
- * A strict representation of an intercepted HTTP request, along with its response. The body, search params and path
- * params are already parsed by default.
- */
+/** @see {@link https://zimic.dev/docs/interceptor/api/http-request-handler#handlerrequests `handler.requests` API reference} */
 interface InterceptedHttpInterceptorRequest<Path extends string, MethodSchema extends HttpMethodSchema, StatusCode extends HttpStatusCode = never> extends HttpInterceptorRequest<Path, MethodSchema> {
     /** The response that was returned for the intercepted request. */
     response: StatusCode extends [never] ? never : HttpInterceptorResponse<MethodSchema, StatusCode>;
@@ -240,64 +226,28 @@ interface RemoteHttpInterceptorOptions extends SharedHttpInterceptorOptions {
 type HttpInterceptorOptions = LocalHttpInterceptorOptions | RemoteHttpInterceptorOptions;
 
 type PartialHttpHeadersOrSchema<Schema extends HttpHeadersSchema.Loose> = IfNever<Schema, never, Partial<Schema> | HttpHeaders<Partial<Schema>> | HttpHeaders<Schema>>;
-/**
- * A static headers restriction to match intercepted requests.
- *
- * @see {@link https://zimic.dev/docs/interceptor/api/http-request-handler#handlerwithrestriction `handler.with()` API reference}
- */
+/** @see {@link https://zimic.dev/docs/interceptor/api/http-request-handler#handlerwithrestriction `handler.with()` API reference} */
 type HttpRequestHandlerHeadersStaticRestriction<Schema extends HttpSchema, Method extends HttpSchemaMethod<Schema>, Path extends HttpSchemaPath<Schema, Method>> = PartialHttpHeadersOrSchema<Default<HttpRequestHeadersSchema<Default<Schema[Path][Method]>>>>;
 type PartialHttpSearchParamsOrSchema<Schema extends HttpSearchParamsSchema.Loose> = IfNever<Schema, never, Partial<Schema> | HttpSearchParams<Partial<Schema>> | HttpSearchParams<Schema>>;
-/**
- * A static search params restriction to match intercepted requests.
- *
- * @see {@link https://zimic.dev/docs/interceptor/api/http-request-handler#handlerwithrestriction `handler.with()` API reference}
- */
+/** @see {@link https://zimic.dev/docs/interceptor/api/http-request-handler#handlerwithrestriction `handler.with()` API reference} */
 type HttpRequestHandlerSearchParamsStaticRestriction<Schema extends HttpSchema, Method extends HttpSchemaMethod<Schema>, Path extends HttpSchemaPath<Schema, Method>> = PartialHttpSearchParamsOrSchema<Default<HttpRequestSearchParamsSchema<Default<Schema[Path][Method]>>>>;
 type PartialBodyOrSchema<Body extends HttpBody> = Body extends HttpFormData<infer Schema> ? HttpFormData<Partial<Schema>> | HttpFormData<Schema> : Body extends HttpSearchParams<infer Schema> ? HttpSearchParams<Partial<Schema>> | HttpSearchParams<Schema> : Body extends Blob ? Body : DeepPartial<Body>;
-/**
- * A static body restriction to match intercepted requests.
- *
- * @see {@link https://zimic.dev/docs/interceptor/api/http-request-handler#handlerwithrestriction `handler.with()` API reference}
- */
+/** @see {@link https://zimic.dev/docs/interceptor/api/http-request-handler#handlerwithrestriction `handler.with()` API reference} */
 type HttpRequestHandlerBodyStaticRestriction<Schema extends HttpSchema, Method extends HttpSchemaMethod<Schema>, Path extends HttpSchemaPath<Schema, Method>> = PartialBodyOrSchema<HttpRequestBodySchema<Default<Schema[Path][Method]>>>;
-/**
- * A static restriction to match intercepted requests.
- *
- * @see {@link https://zimic.dev/docs/interceptor/api/http-request-handler#handlerwithrestriction `handler.with()` API reference}
- */
+/** @see {@link https://zimic.dev/docs/interceptor/api/http-request-handler#handlerwithrestriction `handler.with()` API reference} */
 interface HttpRequestHandlerStaticRestriction<Schema extends HttpSchema, Method extends HttpSchemaMethod<Schema>, Path extends HttpSchemaPath<Schema, Method>> {
-    /**
-     * A set of headers that the intercepted request must contain to match the handler. If exact is `true`, the request
-     * must contain exactly these headers and no others.
-     */
+    /** @see {@link https://zimic.dev/docs/interceptor/api/http-request-handler#handlerwithrestriction `handler.with()` API reference} */
     headers?: HttpRequestHandlerHeadersStaticRestriction<Schema, Method, Path>;
-    /**
-     * A set of search params that the intercepted request must contain to match the handler. If exact is `true`, the
-     * request must contain exactly these search params and no others.
-     */
+    /** @see {@link https://zimic.dev/docs/interceptor/api/http-request-handler#handlerwithrestriction `handler.with()` API reference} */
     searchParams?: HttpRequestHandlerSearchParamsStaticRestriction<Schema, Method, Path>;
-    /**
-     * The body that the intercepted request must contain to match the handler. If exact is `true`, the request must
-     * contain exactly this body and no other.
-     */
+    /** @see {@link https://zimic.dev/docs/interceptor/api/http-request-handler#handlerwithrestriction `handler.with()` API reference} */
     body?: HttpRequestHandlerBodyStaticRestriction<Schema, Method, Path>;
-    /**
-     * If `true`, the request must contain **exactly** the headers, search params, and body declared in this restriction.
-     * Otherwise, the request must contain **at least** them.
-     */
+    /** @see {@link https://zimic.dev/docs/interceptor/api/http-request-handler#handlerwithrestriction `handler.with()` API reference} */
     exact?: boolean;
 }
-/**
- * A computed restriction to match intercepted requests.
- *
- * @see {@link https://zimic.dev/docs/interceptor/api/http-request-handler#handlerwithrestriction `handler.with()` API reference}
- */
+/** @see {@link https://zimic.dev/docs/interceptor/api/http-request-handler#handlerwithrestriction `handler.with()` API reference} */
 type HttpRequestHandlerComputedRestriction<Schema extends HttpSchema, Method extends HttpSchemaMethod<Schema>, Path extends HttpSchemaPath<Schema, Method>> = (request: HttpInterceptorRequest<Path, Default<Schema[Path][Method]>>) => PossiblePromise<boolean>;
-/**
- * A restriction to match intercepted requests.
- *
- * @see {@link https://zimic.dev/docs/interceptor/api/http-request-handler#handlerwithrestriction `handler.with()` API reference}
- */
+/** @see {@link https://zimic.dev/docs/interceptor/api/http-request-handler#handlerwithrestriction `handler.with()` API reference} */
 type HttpRequestHandlerRestriction<Schema extends HttpSchema, Method extends HttpSchemaMethod<Schema>, Path extends HttpSchemaPath<Schema, Method>> = HttpRequestHandlerStaticRestriction<Schema, Method, Path> | HttpRequestHandlerComputedRestriction<Schema, Method, Path>;
 interface RestrictionDiff<Value> {
     expected: Value;
@@ -314,143 +264,34 @@ interface UnmatchedHttpInterceptorRequestGroup {
     diff: RestrictionDiffs;
 }
 
-/**
- * An HTTP request handler to declare responses for intercepted requests.
- *
- * When multiple handlers of the same interceptor match the same method and path, the _last_ handler created with
- * {@link https://zimic.dev/docs/interceptor/api/http-interceptor#interceptormethodpath `interceptor.<method>(path)`}
- * will be used.
- *
- * @see {@link https://zimic.dev/docs/interceptor/api/http-request-handler `HttpRequestHandler` API reference}
- */
+/** @see {@link https://zimic.dev/docs/interceptor/api/http-request-handler `HttpRequestHandler` API reference} */
 interface HttpRequestHandler<Schema extends HttpSchema, Method extends HttpSchemaMethod<Schema>, Path extends HttpSchemaPath<Schema, Method>> {
     /**
-     * The method that matches this handler.
-     *
      * @readonly
      * @see {@link https://zimic.dev/docs/interceptor/api/http-request-handler#handlermethod `handler.method` API reference}
      */
     get method(): Method;
     /**
-     * The path that matches this handler. The base URL of the interceptor is not included, but it is used when matching
-     * requests.
-     *
      * @readonly
      * @see {@link https://zimic.dev/docs/interceptor/api/http-request-handler#handlerpath `handler.path` API reference}
      */
     get path(): Path;
 }
-/**
- * A local HTTP request handler to declare responses for intercepted requests. In a local handler, the mocking
- * operations are synchronous and are executed in the same process where it was created.
- *
- * When multiple handlers of the same interceptor match the same method and path, the _last_ handler created with
- * {@link https://zimic.dev/docs/interceptor/api/http-interceptor#interceptormethodpath `interceptor.<method>(path)`}
- * will be used.
- *
- * @see {@link https://zimic.dev/docs/interceptor/api/http-request-handler `HttpRequestHandler` API reference}
- */
+/** @see {@link https://zimic.dev/docs/interceptor/api/http-request-handler `HttpRequestHandler` API reference} */
 interface LocalHttpRequestHandler<Schema extends HttpSchema, Method extends HttpSchemaMethod<Schema>, Path extends HttpSchemaPath<Schema, Method>, StatusCode extends HttpStatusCode = never> extends HttpRequestHandler<Schema, Method, Path> {
     /** @readonly */
     get type(): 'local';
-    /**
-     * Declares a restriction to intercepted request matches. `headers`, `searchParams`, and `body` are supported to limit
-     * which requests will match the handler and receive the mock response. If multiple restrictions are declared, either
-     * in a single object or with multiple calls to `handler.with()`, all of them must be met, essentially creating an AND
-     * condition.
-     *
-     * By default, restrictions use `exact: false`, meaning that any request **containing** the declared restrictions will
-     * match the handler, regardless of having more properties or values. If you want to match only requests with the
-     * exact values declared, you can use `exact: true`.
-     *
-     * A function is also supported to declare restrictions, in case they are dynamic.
-     *
-     * @param restriction The restriction to match intercepted requests.
-     * @returns The same handler, now considering the specified restriction.
-     * @see {@link https://zimic.dev/docs/interceptor/api/http-request-handler#handlerwithrestriction `handler.with()` API reference}
-     */
+    /** @see {@link https://zimic.dev/docs/interceptor/api/http-request-handler#handlerwithrestriction `handler.with()` API reference} */
     with: (restriction: HttpRequestHandlerRestriction<Schema, Method, Path>) => this;
-    /**
-     * Declares a response to return for matched intercepted requests.
-     *
-     * When the handler matches a request, it will respond with the given declaration. The response type is statically
-     * validated against the schema of the interceptor.
-     *
-     * @param declaration The response declaration or a factory to create it.
-     * @returns The same handler, now including type information about the response declaration based on the specified
-     *   status code.
-     * @see {@link https://zimic.dev/docs/interceptor/api/http-request-handler#handlerrespond `handler.respond()` API reference}
-     */
+    /** @see {@link https://zimic.dev/docs/interceptor/api/http-request-handler#handlerrespond `handler.respond()` API reference} */
     respond: <NewStatusCode extends HttpResponseSchemaStatusCode<Default<Default<Schema[Path][Method]>['response']>>>(declaration: HttpRequestHandlerResponseDeclaration<Default<Schema[Path][Method]>, NewStatusCode> | HttpRequestHandlerResponseDeclarationFactory<Path, Default<Schema[Path][Method]>, NewStatusCode>) => LocalHttpRequestHandler<Schema, Method, Path, NewStatusCode>;
-    /**
-     * Declares a number of intercepted requests that the handler will be able to match and return its response.
-     *
-     * If only one argument is provided, the handler will match exactly that number of requests. In case of two arguments,
-     * the handler will consider an inclusive range, matching at least the minimum (first argument) and at most the
-     * maximum (second argument) number of requests.
-     *
-     * Once the handler receives more requests than the maximum number declared, it will stop matching requests and
-     * returning its response. In this case, Zimic will try other handlers until one eligible is found, otherwise the
-     * request will be either bypassed or rejected. Learn more about how Zimic decides which handler to use for an
-     * intercepted request in the
-     * {@link https://zimic.dev/docs/interceptor/api/http-interceptor#declaring-request-handlers Declaring request handlers}.
-     *
-     * **Important**: To make sure that all expected requests were made, use
-     * {@link https://zimic.dev/docs/interceptor/api/http-interceptor#interceptorchecktimes `interceptor.checkTimes()`} or
-     * {@link https://zimic.dev/docs/interceptor/api/http-request-handler#handlertimes `handler.times()`}.
-     * {@link https://zimic.dev/docs/interceptor/api/http-interceptor#interceptorchecktimes `interceptor.checkTimes()`} is
-     * generally preferred, as it checks all handlers created by the interceptor with a single call.
-     *
-     * @param numberOfRequests The number of times the handler should match intercepted requests.
-     * @param minNumberOfRequests The minimum number of times the handler should match intercepted requests.
-     * @param maxNumberOfRequests The maximum number of times the handler should match intercepted requests.
-     * @returns The same handler, now considering the specified number of times.
-     * @see {@link https://zimic.dev/docs/interceptor/api/http-request-handler#handlertimes `handler.times()` API reference}
-     */
+    /** @see {@link https://zimic.dev/docs/interceptor/api/http-request-handler#handlertimes `handler.times()` API reference} */
     times: ((numberOfRequests: number) => this) & ((minNumberOfRequests: number, maxNumberOfRequests: number) => this);
-    /**
-     * Checks if the handler has matched the expected number of requests declared with
-     * {@link https://zimic.dev/docs/interceptor/api/http-request-handler#handlertimes `handler.times()`}.
-     *
-     * If the handler has matched fewer or more requests than expected, this method will throw a `TimesCheckError` error
-     * pointing to the
-     * {@link https://zimic.dev/docs/interceptor/api/http-request-handler#handlertimes `handler.times()` API reference}
-     * that was not satisfied.
-     *
-     * When {@link https://zimic.dev/docs/interceptor/api/create-http-interceptor `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://zimic.dev/docs/interceptor/api/http-request-handler#handlerwithrestriction restrictions}.
-     *
-     * @throws {TimesCheckError} If the handler has matched less or more requests than the expected number of requests.
-     * @see {@link https://zimic.dev/docs/interceptor/api/http-request-handler#handlerchecktimes `handler.checkTimes()` API reference}
-     */
+    /** @see {@link https://zimic.dev/docs/interceptor/api/http-request-handler#handlerchecktimes `handler.checkTimes()` API reference} */
     checkTimes: () => void;
-    /**
-     * Clears any response declared with
-     * [`handler.respond(declaration)`](https://zimic.dev/docs/interceptor/api/http-request-handler#handlerresponddeclaration),
-     * restrictions declared with
-     * [`handler.with(restriction)`](https://zimic.dev/docs/interceptor/api/http-request-handler#handlerwithrestriction),
-     * and intercepted requests, making the handler stop matching requests. The next handler, created before this one,
-     * that matches the same method and path will be used if present. If not, the requests of the method and path will not
-     * be intercepted.
-     *
-     * To make the handler match requests again, register a new response with
-     * {@link https://zimic.dev/docs/interceptor/api/http-request-handler#handlerrespond `handler.respond()`}.
-     *
-     * @returns The same handler, now cleared of any declared responses, restrictions, and intercepted requests.
-     * @see {@link https://zimic.dev/docs/interceptor/api/http-request-handler#handlerclear `handler.clear()` API reference}
-     */
+    /** @see {@link https://zimic.dev/docs/interceptor/api/http-request-handler#handlerclear `handler.clear()` API reference} */
     clear: () => this;
     /**
-     * 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
-     * {@link https://zimic.dev/docs/interceptor/api/create-http-interceptor `requestSaving.enabled`} is `true` in the
-     * interceptor.
-     *
-     * @throws {DisabledRequestSavingError} If the interceptor has `requestSaving.enabled: false`.
      * @readonly
      * @see {@link https://zimic.dev/docs/interceptor/api/http-request-handler#handlerrequests `handler.requests` API reference}
      */
@@ -465,104 +306,17 @@ interface LocalHttpRequestHandler<Schema extends HttpSchema, Method extends Http
 interface SyncedRemoteHttpRequestHandler<Schema extends HttpSchema, Method extends HttpSchemaMethod<Schema>, Path extends HttpSchemaPath<Schema, Method>, StatusCode extends HttpStatusCode = never> extends HttpRequestHandler<Schema, Method, Path> {
     /** @readonly */
     get type(): 'remote';
-    /**
-     * Declares a restriction to intercepted request matches. `headers`, `searchParams`, and `body` are supported to limit
-     * which requests will match the handler and receive the mock response. If multiple restrictions are declared, either
-     * in a single object or with multiple calls to `handler.with()`, all of them must be met, essentially creating an AND
-     * condition.
-     *
-     * By default, restrictions use `exact: false`, meaning that any request **containing** the declared restrictions will
-     * match the handler, regardless of having more properties or values. If you want to match only requests with the
-     * exact values declared, you can use `exact: true`.
-     *
-     * A function is also supported to declare restrictions, in case they are dynamic.
-     *
-     * @param restriction The restriction to match intercepted requests.
-     * @returns The same handler, now considering the specified restriction.
-     * @see {@link https://zimic.dev/docs/interceptor/api/http-request-handler#handlerwithrestriction `handler.with()` API reference}
-     */
+    /** @see {@link https://zimic.dev/docs/interceptor/api/http-request-handler#handlerwithrestriction `handler.with()` API reference} */
     with: (restriction: HttpRequestHandlerRestriction<Schema, Method, Path>) => PendingRemoteHttpRequestHandler<Schema, Method, Path, StatusCode>;
-    /**
-     * Declares a response to return for matched intercepted requests.
-     *
-     * When the handler matches a request, it will respond with the given declaration. The response type is statically
-     * validated against the schema of the interceptor.
-     *
-     * @param declaration The response declaration or a factory to create it.
-     * @returns The same handler, now including type information about the response declaration based on the specified
-     *   status code.
-     * @see {@link https://zimic.dev/docs/interceptor/api/http-request-handler#handlerrespond `handler.respond()` API reference}
-     */
+    /** @see {@link https://zimic.dev/docs/interceptor/api/http-request-handler#handlerrespond `handler.respond()` API reference} */
     respond: <NewStatusCode extends HttpResponseSchemaStatusCode<Default<Default<Schema[Path][Method]>['response']>>>(declaration: HttpRequestHandlerResponseDeclaration<Default<Schema[Path][Method]>, NewStatusCode> | HttpRequestHandlerResponseDeclarationFactory<Path, Default<Schema[Path][Method]>, NewStatusCode>) => PendingRemoteHttpRequestHandler<Schema, Method, Path, NewStatusCode>;
-    /**
-     * Declares a number of intercepted requests that the handler will be able to match and return its response.
-     *
-     * If only one argument is provided, the handler will match exactly that number of requests. In case of two arguments,
-     * the handler will consider an inclusive range, matching at least the minimum (first argument) and at most the
-     * maximum (second argument) number of requests.
-     *
-     * Once the handler receives more requests than the maximum number declared, it will stop matching requests and
-     * returning its response. In this case, Zimic will try other handlers until one eligible is found, otherwise the
-     * request will be either bypassed or rejected. Learn more about how Zimic decides which handler to use for an
-     * intercepted request in the
-     * {@link https://zimic.dev/docs/interceptor/api/http-interceptor#declaring-request-handlers Declaring request handlers}.
-     *
-     * **Important**: To make sure that all expected requests were made, use
-     * {@link https://zimic.dev/docs/interceptor/api/http-interceptor#interceptorchecktimes `interceptor.checkTimes()`} or
-     * {@link https://zimic.dev/docs/interceptor/api/http-request-handler#handlerchecktimes `handler.checkTimes()`}.
-     * {@link https://zimic.dev/docs/interceptor/api/http-interceptor#interceptorchecktimes `interceptor.checkTimes()`} is
-     * generally preferred, as it checks all handlers created by the interceptor with a single call.
-     *
-     * @param numberOfRequests The number of times the handler should match intercepted requests.
-     * @param minNumberOfRequests The minimum number of times the handler should match intercepted requests.
-     * @param maxNumberOfRequests The maximum number of times the handler should match intercepted requests.
-     * @returns The same handler, now considering the specified number of times.
-     * @see {@link https://zimic.dev/docs/interceptor/api/http-request-handler#handlertimes `handler.times()` API reference}
-     */
+    /** @see {@link https://zimic.dev/docs/interceptor/api/http-request-handler#handlertimes `handler.times()` API reference} */
     times: ((numberOfRequests: number) => PendingRemoteHttpRequestHandler<Schema, Method, Path, StatusCode>) & ((minNumberOfRequests: number, maxNumberOfRequests: number) => PendingRemoteHttpRequestHandler<Schema, Method, Path, StatusCode>);
-    /**
-     * Checks if the handler has matched the expected number of requests declared with
-     * {@link https://zimic.dev/docs/interceptor/api/http-request-handler#handlertimes `handler.times()`}.
-     *
-     * If the handler has matched fewer or more requests than expected, this method will throw a `TimesCheckError` error
-     * pointing to the
-     * {@link https://zimic.dev/docs/interceptor/api/http-request-handler#handlertimes `handler.times()` API reference}
-     * that was not satisfied.
-     *
-     * When {@link https://zimic.dev/docs/interceptor/api/create-http-interceptor `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://zimic.dev/docs/interceptor/api/http-request-handler#handlerwithrestriction restrictions}.
-     *
-     * @throws {TimesCheckError} If the handler has matched less or more requests than the expected number of requests.
-     * @see {@link https://zimic.dev/docs/interceptor/api/http-request-handler#handlerchecktimes `handler.checkTimes()` API reference}
-     */
+    /** @see {@link https://zimic.dev/docs/interceptor/api/http-request-handler#handlerchecktimes `handler.checkTimes()` API reference} */
     checkTimes: () => Promise<void>;
-    /**
-     * Clears any response declared with
-     * [`handler.respond(declaration)`](https://zimic.dev/docs/interceptor/api/http-request-handler#handlerresponddeclaration),
-     * restrictions declared with
-     * [`handler.with(restriction)`](https://zimic.dev/docs/interceptor/api/http-request-handler#handlerwithrestriction),
-     * and intercepted requests, making the handler stop matching requests. The next handler, created before this one,
-     * that matches the same method and path will be used if present. If not, the requests of the method and path will not
-     * be intercepted.
-     *
-     * To make the handler match requests again, register a new response with
-     * {@link https://zimic.dev/docs/interceptor/api/http-request-handler#handlerrespond `handler.respond()`}.
-     *
-     * @returns The same handler, now cleared of any declared responses, restrictions, and intercepted requests.
-     * @see {@link https://zimic.dev/docs/interceptor/api/http-request-handler#handlerclear `handler.clear()` API reference}
-     */
+    /** @see {@link https://zimic.dev/docs/interceptor/api/http-request-handler#handlerclear `handler.clear()` API reference} */
     clear: () => PendingRemoteHttpRequestHandler<Schema, Method, Path, StatusCode>;
     /**
-     * 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
-     * {@link https://zimic.dev/docs/interceptor/api/create-http-interceptor `requestSaving.enabled`} is `true` in the
-     * interceptor.
-     *
-     * @throws {DisabledRequestSavingError} If the interceptor has `requestSaving.enabled: false`.
      * @readonly
      * @see {@link https://zimic.dev/docs/interceptor/api/http-request-handler#handlerrequests `handler.requests` API reference}
      */