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

package/dist/http.d.ts

@@ -617,475 +617,81 @@ interface HttpInterceptorRequestSaving {
     /** @see {@link https://zimic.dev/docs/interceptor/api/create-http-interceptor `createHttpInterceptor` API reference} */
     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.
- *
- * @see {@link https://zimic.dev/docs/interceptor/api/http-interceptor `HttpInterceptor` API reference}
- */
+/** @see {@link https://zimic.dev/docs/interceptor/api/http-interceptor `HttpInterceptor` API reference} */
 interface HttpInterceptor<_Schema extends HttpSchema> {
-    /**
-     * The base URL used by the interceptor.
-     *
-     * @see {@link https://zimic.dev/docs/interceptor/api/http-interceptor#interceptorbaseurl `interceptor.baseURL` API reference}
-     */
+    /** @see {@link https://zimic.dev/docs/interceptor/api/http-interceptor#interceptorbaseurl `interceptor.baseURL` API reference} */
     baseURL: string;
-    /**
-     * Configures if the intercepted requests are saved and how they are handled.
-     *
-     * @see {@link https://zimic.dev/docs/interceptor/api/create-http-interceptor `createHttpInterceptor` API reference}
-     * @see {@link https://zimic.dev/docs/interceptor/guides/http/testing Testing}
-     */
+    /** @see {@link https://zimic.dev/docs/interceptor/api/http-interceptor#interceptorrequestsaving `interceptor.requestSaving` API reference} */
     requestSaving: HttpInterceptorRequestSaving;
-    /**
-     * The strategy to use for unhandled requests. If a request starts with the base URL of the interceptor, but no
-     * matching handler exists, this strategy will be used. If a function is provided, it will be called with the
-     * unhandled request.
-     *
-     * @see {@link https://zimic.dev/docs/interceptor/guides/http/unhandled-requests Unhandled requests}
-     */
+    /** @see {@link https://zimic.dev/docs/interceptor/api/http-interceptor#interceptoronunhandledrequest `interceptor.onUnhandledRequest` API reference} */
     onUnhandledRequest?: UnhandledRequestStrategy;
     /**
-     * The platform the interceptor is running on.
-     *
      * @readonly
      * @see {@link https://zimic.dev/docs/interceptor/api/http-interceptor#interceptorplatform `interceptor.platform` API reference}
      */
     get platform(): HttpInterceptorPlatform | null;
     /**
-     * Whether the interceptor is currently running and ready to use.
-     *
      * @readonly
      * @see {@link https://zimic.dev/docs/interceptor/api/http-interceptor#interceptorisrunning `interceptor.isRunning` API reference}
      */
     get isRunning(): boolean;
-    /**
-     * Starts the interceptor, allowing it to intercept HTTP requests.
-     *
-     * When targeting a browser environment, make sure to run `npx zimic-interceptor browser init <publicDirectory>` on
-     * your terminal before starting the worker. This initializes the mock service worker in your public directory.
-     *
-     * @throws {UnregisteredServiceWorkerError} When the worker is targeting a browser environment and the mock service
-     *   worker is not registered.
-     * @see {@link https://zimic.dev/docs/interceptor/api/http-interceptor#interceptorstart `interceptor.start()` API reference}
-     */
+    /** @see {@link https://zimic.dev/docs/interceptor/api/http-interceptor#interceptorstart `interceptor.start()` API reference} */
     start: () => Promise<void>;
-    /**
-     * Stops the interceptor, preventing it from intercepting HTTP requests. Stopped interceptors are automatically
-     * cleared, exactly as if
-     * {@link https://zimic.dev/docs/interceptor/api/http-interceptor#interceptorclear `interceptor.clear()`} had been
-     * called.
-     *
-     * @see {@link https://zimic.dev/docs/interceptor/api/http-interceptor#interceptorstop `interceptor.stop()` API reference}
-     */
+    /** @see {@link https://zimic.dev/docs/interceptor/api/http-interceptor#interceptorstop `interceptor.stop()` API reference} */
     stop: () => Promise<void>;
-    /**
-     * Checks if all handlers created by this interceptor have matched the number of requests declared with
-     * {@link https://zimic.dev/docs/interceptor/api/http-request-handler#handlertimes `handler.times()`}.
-     *
-     * If some handler has matched fewer or more requests than expected, this method will throw a `TimesCheckError` error,
-     * including a stack trace to the
-     * {@link https://zimic.dev/docs/interceptor/api/http-request-handler#handlertimes `handler.times()`} that was not
-     * satisfied.
-     *
-     * This is useful in an `afterEach` hook (or equivalent) to make sure that all expected requests were made at the end
-     * of each test.
-     *
-     * 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 some handler has matched less or more requests than the expected number of requests.
-     * @see {@link https://zimic.dev/docs/interceptor/api/http-interceptor#interceptorchecktimes `interceptor.checkTimes()` API reference}
-     * @see {@link https://zimic.dev/docs/interceptor/guides/http/testing Testing guide}
-     */
+    /** @see {@link https://zimic.dev/docs/interceptor/api/http-interceptor#interceptorchecktimes `interceptor.checkTimes()` API reference} */
     checkTimes: (() => void) | (() => Promise<void>);
-    /**
-     * Clears the interceptor and all of its
-     * {@link https://zimic.dev/docs/interceptor/api/http-request-handler `HttpRequestHandler`} instances, including their
-     * registered responses and intercepted requests. After calling this method, the interceptor will no longer intercept
-     * any requests until new mock responses are registered.
-     *
-     * This method is useful to reset the interceptor mocks between tests.
-     *
-     * @throws {NotRunningHttpInterceptorError} If the interceptor is not running.
-     * @see {@link https://zimic.dev/docs/interceptor/api/http-interceptor#interceptorclear `interceptor.clear()` API reference}
-     */
+    /** @see {@link https://zimic.dev/docs/interceptor/api/http-interceptor#interceptorclear `interceptor.clear()` API reference} */
     clear: (() => void) | (() => Promise<void>);
 }
 /**
- * A local 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.
- *
- * To intercept HTTP requests, the interceptor must have been started with
- * {@link https://zimic.dev/docs/interceptor/api/http-interceptor#interceptorstart `interceptor.start()`}.
- *
  * @see {@link https://zimic.dev/docs/interceptor/api/http-interceptor `HttpInterceptor` API reference}
+ * @see {@link https://zimic.dev/docs/interceptor/guides/http/local-interceptors Using local interceptors}
  */
 interface LocalHttpInterceptor<Schema extends HttpSchema> extends HttpInterceptor<Schema> {
     /** @readonly */
     get type(): 'local';
     onUnhandledRequest?: UnhandledRequestStrategy.Local;
-    /**
-     * Creates a GET {@link https://zimic.dev/docs/interceptor/api/http-request-handler `HttpRequestHandler`} for a path.
-     * The path and method must be declared in the interceptor schema.
-     *
-     * After a request is intercepted, Zimic tries to find a handler that matches it, considering the base URL of the
-     * interceptor, and the method, path,
-     * {@link https://zimic.dev/docs/interceptor/api/http-request-handler#handlerwithrestriction restrictions}, and
-     * {@link https://zimic.dev/docs/interceptor/api/http-request-handler#handlertimes limits on the number of requests} of
-     * the handler. The handlers are checked from the **last** one created to the first one, so new handlers have
-     * preference over older ones. This allows you to declare generic and specific handlers based on their order of
-     * creation. For example, a generic handler for `GET /users` can return an empty list, while a specific handler in a
-     * test case can return a list with some users. In this case, the specific handler will be considered first as long as
-     * it is created **after** the generic one.
-     *
-     * @param path The path to intercept. Paths with dynamic parameters, such as `/users/:id`, are supported, but you need
-     *   to specify the original path as a type parameter to get type-inference and type-validation.
-     * @returns A GET {@link https://zimic.dev/docs/interceptor/api/http-request-handler `HttpRequestHandler`} for the
-     *   provided path. The path and method must be declared in the interceptor schema.
-     * @throws {NotRunningHttpInterceptorError} If the interceptor is not running.
-     * @see {@link https://zimic.dev/docs/interceptor/api/http-interceptor#declaring-request-handlers Declaring request handlers}
-     */
+    /** @see {@link https://zimic.dev/docs/interceptor/api/http-interceptor#interceptorget `interceptor.get()` API reference} */
     get: SyncHttpInterceptorMethodHandler<Schema, 'GET'>;
-    /**
-     * Creates a POST {@link https://zimic.dev/docs/interceptor/api/http-request-handler `HttpRequestHandler`} for a path.
-     * The path and method must be declared in the interceptor schema.
-     *
-     * After a request is intercepted, Zimic tries to find a handler that matches it, considering the base URL of the
-     * interceptor, and the method, path,
-     * {@link https://zimic.dev/docs/interceptor/api/http-request-handler#handlerwithrestriction restrictions}, and
-     * {@link https://zimic.dev/docs/interceptor/api/http-request-handler#handlertimes limits on the number of requests} of
-     * the handler. The handlers are checked from the **last** one created to the first one, so new handlers have
-     * preference over older ones. This allows you to declare generic and specific handlers based on their order of
-     * creation. For example, a generic handler for `GET /users` can return an empty list, while a specific handler in a
-     * test case can return a list with some users. In this case, the specific handler will be considered first as long as
-     * it is created **after** the generic one.
-     *
-     * @param path The path to intercept. Paths with dynamic parameters, such as `/users/:id`, are supported, but you need
-     *   to specify the original path as a type parameter to get type-inference and type-validation.
-     * @returns A POST {@link https://zimic.dev/docs/interceptor/api/http-request-handler `HttpRequestHandler`} for the
-     *   provided path. The path and method must be declared in the interceptor schema.
-     * @throws {NotRunningHttpInterceptorError} If the interceptor is not running.
-     * @see {@link https://zimic.dev/docs/interceptor/api/http-interceptor#declaring-request-handlers Declaring request handlers}
-     */
+    /** @see {@link https://zimic.dev/docs/interceptor/api/http-interceptor#interceptorpost `interceptor.post()` API reference} */
     post: SyncHttpInterceptorMethodHandler<Schema, 'POST'>;
-    /**
-     * Creates a PATCH {@link https://zimic.dev/docs/interceptor/api/http-request-handler `HttpRequestHandler`} for a path.
-     * The path and method must be declared in the interceptor schema.
-     *
-     * After a request is intercepted, Zimic tries to find a handler that matches it, considering the base URL of the
-     * interceptor, and the method, path,
-     * {@link https://zimic.dev/docs/interceptor/api/http-request-handler#handlerwithrestriction restrictions}, and
-     * {@link https://zimic.dev/docs/interceptor/api/http-request-handler#handlertimes limits on the number of requests} of
-     * the handler. The handlers are checked from the **last** one created to the first one, so new handlers have
-     * preference over older ones. This allows you to declare generic and specific handlers based on their order of
-     * creation. For example, a generic handler for `GET /users` can return an empty list, while a specific handler in a
-     * test case can return a list with some users. In this case, the specific handler will be considered first as long as
-     * it is created **after** the generic one.
-     *
-     * @param path The path to intercept. Paths with dynamic parameters, such as `/users/:id`, are supported, but you need
-     *   to specify the original path as a type parameter to get type-inference and type-validation.
-     * @returns A PATCH {@link https://zimic.dev/docs/interceptor/api/http-request-handler `HttpRequestHandler`} for the
-     *   provided path. The path and method must be declared in the interceptor schema.
-     * @throws {NotRunningHttpInterceptorError} If the interceptor is not running.
-     * @see {@link https://zimic.dev/docs/interceptor/api/http-interceptor#declaring-request-handlers Declaring request handlers}
-     */
+    /** @see {@link https://zimic.dev/docs/interceptor/api/http-interceptor#interceptorpatch `interceptor.patch()` API reference} */
     patch: SyncHttpInterceptorMethodHandler<Schema, 'PATCH'>;
-    /**
-     * Creates a PUT {@link https://zimic.dev/docs/interceptor/api/http-request-handler `HttpRequestHandler`} for a path.
-     * The path and method must be declared in the interceptor schema.
-     *
-     * After a request is intercepted, Zimic tries to find a handler that matches it, considering the base URL of the
-     * interceptor, and the method, path,
-     * {@link https://zimic.dev/docs/interceptor/api/http-request-handler#handlerwithrestriction restrictions}, and
-     * {@link https://zimic.dev/docs/interceptor/api/http-request-handler#handlertimes limits on the number of requests} of
-     * the handler. The handlers are checked from the **last** one created to the first one, so new handlers have
-     * preference over older ones. This allows you to declare generic and specific handlers based on their order of
-     * creation. For example, a generic handler for `GET /users` can return an empty list, while a specific handler in a
-     * test case can return a list with some users. In this case, the specific handler will be considered first as long as
-     * it is created **after** the generic one.
-     *
-     * @param path The path to intercept. Paths with dynamic parameters, such as `/users/:id`, are supported, but you need
-     *   to specify the original path as a type parameter to get type-inference and type-validation.
-     * @returns A PUT {@link https://zimic.dev/docs/interceptor/api/http-request-handler `HttpRequestHandler`} for the
-     *   provided path. The path and method must be declared in the interceptor schema.
-     * @throws {NotRunningHttpInterceptorError} If the interceptor is not running.
-     * @see {@link https://zimic.dev/docs/interceptor/api/http-interceptor#declaring-request-handlers Declaring request handlers}
-     */
+    /** @see {@link https://zimic.dev/docs/interceptor/api/http-interceptor#interceptorput `interceptor.put()` API reference} */
     put: SyncHttpInterceptorMethodHandler<Schema, 'PUT'>;
-    /**
-     * Creates a DELETE {@link https://zimic.dev/docs/interceptor/api/http-request-handler `HttpRequestHandler`} for a
-     * path. The path and method must be declared in the interceptor schema.
-     *
-     * After a request is intercepted, Zimic tries to find a handler that matches it, considering the base URL of the
-     * interceptor, and the method, path,
-     * {@link https://zimic.dev/docs/interceptor/api/http-request-handler#handlerwithrestriction restrictions}, and
-     * {@link https://zimic.dev/docs/interceptor/api/http-request-handler#handlertimes limits on the number of requests} of
-     * the handler. The handlers are checked from the **last** one created to the first one, so new handlers have
-     * preference over older ones. This allows you to declare generic and specific handlers based on their order of
-     * creation. For example, a generic handler for `GET /users` can return an empty list, while a specific handler in a
-     * test case can return a list with some users. In this case, the specific handler will be considered first as long as
-     * it is created **after** the generic one.
-     *
-     * @param path The path to intercept. Paths with dynamic parameters, such as `/users/:id`, are supported, but you need
-     *   to specify the original path as a type parameter to get type-inference and type-validation.
-     * @returns A DELETE {@link https://zimic.dev/docs/interceptor/api/http-request-handler `HttpRequestHandler`} for the
-     *   provided path. The path and method must be declared in the interceptor schema.
-     * @throws {NotRunningHttpInterceptorError} If the interceptor is not running.
-     * @see {@link https://zimic.dev/docs/interceptor/api/http-interceptor#declaring-request-handlers Declaring request handlers}
-     */
+    /** @see {@link https://zimic.dev/docs/interceptor/api/http-interceptor#interceptordelete `interceptor.delete()` API reference} */
     delete: SyncHttpInterceptorMethodHandler<Schema, 'DELETE'>;
-    /**
-     * Creates a HEAD {@link https://zimic.dev/docs/interceptor/api/http-request-handler `HttpRequestHandler`} for a path.
-     * The path and method must be declared in the interceptor schema.
-     *
-     * After a request is intercepted, Zimic tries to find a handler that matches it, considering the base URL of the
-     * interceptor, and the method, path,
-     * {@link https://zimic.dev/docs/interceptor/api/http-request-handler#handlerwithrestriction restrictions}, and
-     * {@link https://zimic.dev/docs/interceptor/api/http-request-handler#handlertimes limits on the number of requests} of
-     * the handler. The handlers are checked from the **last** one created to the first one, so new handlers have
-     * preference over older ones. This allows you to declare generic and specific handlers based on their order of
-     * creation. For example, a generic handler for `GET /users` can return an empty list, while a specific handler in a
-     * test case can return a list with some users. In this case, the specific handler will be considered first as long as
-     * it is created **after** the generic one.
-     *
-     * @param path The path to intercept. Paths with dynamic parameters, such as `/users/:id`, are supported, but you need
-     *   to specify the original path as a type parameter to get type-inference and type-validation.
-     * @returns A HEAD {@link https://zimic.dev/docs/interceptor/api/http-request-handler `HttpRequestHandler`} for the
-     *   provided path. The path and method must be declared in the interceptor schema.
-     * @throws {NotRunningHttpInterceptorError} If the interceptor is not running.
-     * @see {@link https://zimic.dev/docs/interceptor/api/http-interceptor#declaring-request-handlers Declaring request handlers}
-     */
+    /** @see {@link https://zimic.dev/docs/interceptor/api/http-interceptor#interceptorhead `interceptor.head()` API reference} */
     head: SyncHttpInterceptorMethodHandler<Schema, 'HEAD'>;
-    /**
-     * Creates an OPTIONS {@link https://zimic.dev/docs/interceptor/api/http-request-handler `HttpRequestHandler`} for a
-     * path. The path and method must be declared in the interceptor schema.
-     *
-     * After a request is intercepted, Zimic tries to find a handler that matches it, considering the base URL of the
-     * interceptor, and the method, path,
-     * {@link https://zimic.dev/docs/interceptor/api/http-request-handler#handlerwithrestriction restrictions}, and
-     * {@link https://zimic.dev/docs/interceptor/api/http-request-handler#handlertimes limits on the number of requests} of
-     * the handler. The handlers are checked from the **last** one created to the first one, so new handlers have
-     * preference over older ones. This allows you to declare generic and specific handlers based on their order of
-     * creation. For example, a generic handler for `GET /users` can return an empty list, while a specific handler in a
-     * test case can return a list with some users. In this case, the specific handler will be considered first as long as
-     * it is created **after** the generic one.
-     *
-     * @param path The path to intercept. Paths with dynamic parameters, such as `/users/:id`, are supported, but you need
-     *   to specify the original path as a type parameter to get type-inference and type-validation.
-     * @returns An OPTIONS {@link https://zimic.dev/docs/interceptor/api/http-request-handler `HttpRequestHandler`} for the
-     *   provided path. The path and method must be declared in the interceptor schema.
-     * @throws {NotRunningHttpInterceptorError} If the interceptor is not running.
-     * @see {@link https://zimic.dev/docs/interceptor/api/http-interceptor#declaring-request-handlers Declaring request handlers}
-     */
+    /** @see {@link https://zimic.dev/docs/interceptor/api/http-interceptor#interceptoroptions `interceptor.options()` API reference} */
     options: SyncHttpInterceptorMethodHandler<Schema, 'OPTIONS'>;
     checkTimes: () => void;
     clear: () => void;
 }
 /**
- * A remote 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.
- *
- * To intercept HTTP requests, the interceptor must have been started with
- * {@link https://zimic.dev/docs/interceptor/api/http-interceptor#interceptorstart `interceptor.start()`} and an
- * {@link https://zimic.dev/docs/interceptor/cli/server interceptor server} should be running.
- *
  * @see {@link https://zimic.dev/docs/interceptor/api/http-interceptor `HttpInterceptor` API reference}
+ * @see {@link https://zimic.dev/docs/interceptor/guides/http/remote-interceptors Using remote interceptors}
  */
 interface RemoteHttpInterceptor<Schema extends HttpSchema> extends HttpInterceptor<Schema> {
     /** @readonly */
     get type(): 'remote';
-    /**
-     * Options to authenticate the interceptor when connecting to an interceptor server. This is required if the
-     * interceptor server was started with the `--tokens-dir` option.
-     *
-     * @see {@link https://zimic.dev/docs/interceptor/guides/http/remote-interceptors#interceptor-server-authentication Interceptor server authentication}
-     */
-    auth?: RemoteHttpInterceptorOptions['auth'];
     onUnhandledRequest?: UnhandledRequestStrategy.Remote;
-    /**
-     * Creates a GET {@link https://zimic.dev/docs/interceptor/api/http-request-handler `HttpRequestHandler`} for a path.
-     * The path and method must be declared in the interceptor schema.
-     *
-     * When using a {@link https://zimic.dev/docs/interceptor/guides/http/remote-interceptors remote interceptor}, creating
-     * a handler is an asynchronous operation, so you need to `await` it. You can also chain any number of operations and
-     * apply them by awaiting the handler.
-     *
-     * After a request is intercepted, Zimic tries to find a handler that matches it, considering the base URL of the
-     * interceptor, and the method, path,
-     * {@link https://zimic.dev/docs/interceptor/api/http-request-handler#handlerwithrestriction restrictions}, and
-     * {@link https://zimic.dev/docs/interceptor/api/http-request-handler#handlertimes limits on the number of requests} of
-     * the handler. The handlers are checked from the **last** one created to the first one, so new handlers have
-     * preference over older ones. This allows you to declare generic and specific handlers based on their order of
-     * creation. For example, a generic handler for `GET /users` can return an empty list, while a specific handler in a
-     * test case can return a list with some users. In this case, the specific handler will be considered first as long as
-     * it is created **after** the generic one.
-     *
-     * @param path The path to intercept. Paths with dynamic parameters, such as `/users/:id`, are supported, but you need
-     *   to specify the original path as a type parameter to get type-inference and type-validation.
-     * @returns A GET {@link https://zimic.dev/docs/interceptor/api/http-request-handler `HttpRequestHandler`} for the
-     *   provided path. The path and method must be declared in the interceptor schema.
-     * @throws {NotRunningHttpInterceptorError} If the interceptor is not running.
-     * @see {@link https://zimic.dev/docs/interceptor/api/http-interceptor#declaring-request-handlers Declaring request handlers}
-     */
+    /** @see {@link https://zimic.dev/docs/interceptor/api/http-interceptor#interceptorauth `interceptor.auth` API reference} */
+    auth?: RemoteHttpInterceptorOptions['auth'];
+    /** @see {@link https://zimic.dev/docs/interceptor/api/http-interceptor#interceptorget `interceptor.get()` API reference} */
     get: AsyncHttpInterceptorMethodHandler<Schema, 'GET'>;
-    /**
-     * Creates a POST {@link https://zimic.dev/docs/interceptor/api/http-request-handler `HttpRequestHandler`} for a path.
-     * The path and method must be declared in the interceptor schema.
-     *
-     * When using a {@link https://zimic.dev/docs/interceptor/guides/http/remote-interceptors remote interceptor}, creating
-     * a handler is an asynchronous operation, so you need to `await` it. You can also chain any number of operations and
-     * apply them by awaiting the handler.
-     *
-     * After a request is intercepted, Zimic tries to find a handler that matches it, considering the base URL of the
-     * interceptor, and the method, path,
-     * {@link https://zimic.dev/docs/interceptor/api/http-request-handler#handlerwithrestriction restrictions}, and
-     * {@link https://zimic.dev/docs/interceptor/api/http-request-handler#handlertimes limits on the number of requests} of
-     * the handler. The handlers are checked from the **last** one created to the first one, so new handlers have
-     * preference over older ones. This allows you to declare generic and specific handlers based on their order of
-     * creation. For example, a generic handler for `GET /users` can return an empty list, while a specific handler in a
-     * test case can return a list with some users. In this case, the specific handler will be considered first as long as
-     * it is created **after** the generic one.
-     *
-     * @param path The path to intercept. Paths with dynamic parameters, such as `/users/:id`, are supported, but you need
-     *   to specify the original path as a type parameter to get type-inference and type-validation.
-     * @returns A POST {@link https://zimic.dev/docs/interceptor/api/http-request-handler `HttpRequestHandler`} for the
-     *   provided path. The path and method must be declared in the interceptor schema.
-     * @throws {NotRunningHttpInterceptorError} If the interceptor is not running.
-     * @see {@link https://zimic.dev/docs/interceptor/api/http-interceptor#declaring-request-handlers Declaring request handlers}
-     */
+    /** @see {@link https://zimic.dev/docs/interceptor/api/http-interceptor#interceptorpost `interceptor.post()` API reference} */
     post: AsyncHttpInterceptorMethodHandler<Schema, 'POST'>;
-    /**
-     * Creates a PATCH {@link https://zimic.dev/docs/interceptor/api/http-request-handler `HttpRequestHandler`} for a path.
-     * The path and method must be declared in the interceptor schema.
-     *
-     * When using a {@link https://zimic.dev/docs/interceptor/guides/http/remote-interceptors remote interceptor}, creating
-     * a handler is an asynchronous operation, so you need to `await` it. You can also chain any number of operations and
-     * apply them by awaiting the handler.
-     *
-     * After a request is intercepted, Zimic tries to find a handler that matches it, considering the base URL of the
-     * interceptor, and the method, path,
-     * {@link https://zimic.dev/docs/interceptor/api/http-request-handler#handlerwithrestriction restrictions}, and
-     * {@link https://zimic.dev/docs/interceptor/api/http-request-handler#handlertimes limits on the number of requests} of
-     * the handler. The handlers are checked from the **last** one created to the first one, so new handlers have
-     * preference over older ones. This allows you to declare generic and specific handlers based on their order of
-     * creation. For example, a generic handler for `GET /users` can return an empty list, while a specific handler in a
-     * test case can return a list with some users. In this case, the specific handler will be considered first as long as
-     * it is created **after** the generic one.
-     *
-     * @param path The path to intercept. Paths with dynamic parameters, such as `/users/:id`, are supported, but you need
-     *   to specify the original path as a type parameter to get type-inference and type-validation.
-     * @returns A PATCH {@link https://zimic.dev/docs/interceptor/api/http-request-handler `HttpRequestHandler`} for the
-     *   provided path. The path and method must be declared in the interceptor schema.
-     * @throws {NotRunningHttpInterceptorError} If the interceptor is not running.
-     * @see {@link https://zimic.dev/docs/interceptor/api/http-interceptor#declaring-request-handlers Declaring request handlers}
-     */
+    /** @see {@link https://zimic.dev/docs/interceptor/api/http-interceptor#interceptorpatch `interceptor.patch()` API reference} */
     patch: AsyncHttpInterceptorMethodHandler<Schema, 'PATCH'>;
-    /**
-     * Creates a PUT {@link https://zimic.dev/docs/interceptor/api/http-request-handler `HttpRequestHandler`} for a path.
-     * The path and method must be declared in the interceptor schema.
-     *
-     * When using a {@link https://zimic.dev/docs/interceptor/guides/http/remote-interceptors remote interceptor}, creating
-     * a handler is an asynchronous operation, so you need to `await` it. You can also chain any number of operations and
-     * apply them by awaiting the handler.
-     *
-     * After a request is intercepted, Zimic tries to find a handler that matches it, considering the base URL of the
-     * interceptor, and the method, path,
-     * {@link https://zimic.dev/docs/interceptor/api/http-request-handler#handlerwithrestriction restrictions}, and
-     * {@link https://zimic.dev/docs/interceptor/api/http-request-handler#handlertimes limits on the number of requests} of
-     * the handler. The handlers are checked from the **last** one created to the first one, so new handlers have
-     * preference over older ones. This allows you to declare generic and specific handlers based on their order of
-     * creation. For example, a generic handler for `GET /users` can return an empty list, while a specific handler in a
-     * test case can return a list with some users. In this case, the specific handler will be considered first as long as
-     * it is created **after** the generic one.
-     *
-     * @param path The path to intercept. Paths with dynamic parameters, such as `/users/:id`, are supported, but you need
-     *   to specify the original path as a type parameter to get type-inference and type-validation.
-     * @returns A PUT {@link https://zimic.dev/docs/interceptor/api/http-request-handler `HttpRequestHandler`} for the
-     *   provided path. The path and method must be declared in the interceptor schema.
-     * @throws {NotRunningHttpInterceptorError} If the interceptor is not running.
-     * @see {@link https://zimic.dev/docs/interceptor/api/http-interceptor#declaring-request-handlers Declaring request handlers}
-     */
+    /** @see {@link https://zimic.dev/docs/interceptor/api/http-interceptor#interceptorput `interceptor.put()` API reference} */
     put: AsyncHttpInterceptorMethodHandler<Schema, 'PUT'>;
-    /**
-     * Creates a DELETE {@link https://zimic.dev/docs/interceptor/api/http-request-handler `HttpRequestHandler`} for a
-     * path. The path and method must be declared in the interceptor schema.
-     *
-     * When using a {@link https://zimic.dev/docs/interceptor/guides/http/remote-interceptors remote interceptor}, creating
-     * a handler is an asynchronous operation, so you need to `await` it. You can also chain any number of operations and
-     * apply them by awaiting the handler.
-     *
-     * After a request is intercepted, Zimic tries to find a handler that matches it, considering the base URL of the
-     * interceptor, and the method, path,
-     * {@link https://zimic.dev/docs/interceptor/api/http-request-handler#handlerwithrestriction restrictions}, and
-     * {@link https://zimic.dev/docs/interceptor/api/http-request-handler#handlertimes limits on the number of requests} of
-     * the handler. The handlers are checked from the **last** one created to the first one, so new handlers have
-     * preference over older ones. This allows you to declare generic and specific handlers based on their order of
-     * creation. For example, a generic handler for `GET /users` can return an empty list, while a specific handler in a
-     * test case can return a list with some users. In this case, the specific handler will be considered first as long as
-     * it is created **after** the generic one.
-     *
-     * @param path The path to intercept. Paths with dynamic parameters, such as `/users/:id`, are supported, but you need
-     *   to specify the original path as a type parameter to get type-inference and type-validation.
-     * @returns A DELETE {@link https://zimic.dev/docs/interceptor/api/http-request-handler `HttpRequestHandler`} for the
-     *   provided path. The path and method must be declared in the interceptor schema.
-     * @throws {NotRunningHttpInterceptorError} If the interceptor is not running.
-     * @see {@link https://zimic.dev/docs/interceptor/api/http-interceptor#declaring-request-handlers Declaring request handlers}
-     */
+    /** @see {@link https://zimic.dev/docs/interceptor/api/http-interceptor#interceptordelete `interceptor.delete()` API reference} */
     delete: AsyncHttpInterceptorMethodHandler<Schema, 'DELETE'>;
-    /**
-     * Creates a HEAD {@link https://zimic.dev/docs/interceptor/api/http-request-handler `HttpRequestHandler`} for a path.
-     * The path and method must be declared in the interceptor schema.
-     *
-     * When using a {@link https://zimic.dev/docs/interceptor/guides/http/remote-interceptors remote interceptor}, creating
-     * a handler is an asynchronous operation, so you need to `await` it. You can also chain any number of operations and
-     * apply them by awaiting the handler.
-     *
-     * After a request is intercepted, Zimic tries to find a handler that matches it, considering the base URL of the
-     * interceptor, and the method, path,
-     * {@link https://zimic.dev/docs/interceptor/api/http-request-handler#handlerwithrestriction restrictions}, and
-     * {@link https://zimic.dev/docs/interceptor/api/http-request-handler#handlertimes limits on the number of requests} of
-     * the handler. The handlers are checked from the **last** one created to the first one, so new handlers have
-     * preference over older ones. This allows you to declare generic and specific handlers based on their order of
-     * creation. For example, a generic handler for `GET /users` can return an empty list, while a specific handler in a
-     * test case can return a list with some users. In this case, the specific handler will be considered first as long as
-     * it is created **after** the generic one.
-     *
-     * @param path The path to intercept. Paths with dynamic parameters, such as `/users/:id`, are supported, but you need
-     *   to specify the original path as a type parameter to get type-inference and type-validation.
-     * @returns A HEAD {@link https://zimic.dev/docs/interceptor/api/http-request-handler `HttpRequestHandler`} for the
-     *   provided path. The path and method must be declared in the interceptor schema.
-     * @throws {NotRunningHttpInterceptorError} If the interceptor is not running.
-     * @see {@link https://zimic.dev/docs/interceptor/api/http-interceptor#declaring-request-handlers Declaring request handlers}
-     */
+    /** @see {@link https://zimic.dev/docs/interceptor/api/http-interceptor#interceptorhead `interceptor.head()` API reference} */
     head: AsyncHttpInterceptorMethodHandler<Schema, 'HEAD'>;
-    /**
-     * Creates an OPTIONS {@link https://zimic.dev/docs/interceptor/api/http-request-handler `HttpRequestHandler`} for a
-     * path. The path and method must be declared in the interceptor schema.
-     *
-     * When using a {@link https://zimic.dev/docs/interceptor/guides/http/remote-interceptors remote interceptor}, creating
-     * a handler is an asynchronous operation, so you need to `await` it. You can also chain any number of operations and
-     * apply them by awaiting the handler.
-     *
-     * After a request is intercepted, Zimic tries to find a handler that matches it, considering the base URL of the
-     * interceptor, and the method, path,
-     * {@link https://zimic.dev/docs/interceptor/api/http-request-handler#handlerwithrestriction restrictions}, and
-     * {@link https://zimic.dev/docs/interceptor/api/http-request-handler#handlertimes limits on the number of requests} of
-     * the handler. The handlers are checked from the **last** one created to the first one, so new handlers have
-     * preference over older ones. This allows you to declare generic and specific handlers based on their order of
-     * creation. For example, a generic handler for `GET /users` can return an empty list, while a specific handler in a
-     * test case can return a list with some users. In this case, the specific handler will be considered first as long as
-     * it is created **after** the generic one.
-     *
-     * @param path The path to intercept. Paths with dynamic parameters, such as `/users/:id`, are supported, but you need
-     *   to specify the original path as a type parameter to get type-inference and type-validation.
-     * @returns An OPTIONS {@link https://zimic.dev/docs/interceptor/api/http-request-handler `HttpRequestHandler`} for the
-     *   provided path. The path and method must be declared in the interceptor schema.
-     * @throws {NotRunningHttpInterceptorError} If the interceptor is not running.
-     * @see {@link https://zimic.dev/docs/interceptor/api/http-interceptor#declaring-request-handlers Declaring request handlers}
-     */
+    /** @see {@link https://zimic.dev/docs/interceptor/api/http-interceptor#interceptoroptions `interceptor.options()` API reference} */
     options: AsyncHttpInterceptorMethodHandler<Schema, 'OPTIONS'>;
     checkTimes: () => Promise<void>;
     clear: () => Promise<void>;

package/dist/server.d.ts

@@ -12,93 +12,36 @@ declare class NotRunningInterceptorServerError extends Error {
     constructor();
 }
 
-/**
- * The options to create an {@link https://zimic.dev/docs/interceptor/cli/server interceptor server}.
- *
- * @see {@link https://zimic.dev/docs/interceptor/cli/server `zimic-interceptor server` API reference}
- */
+/** @see {@link https://zimic.dev/docs/interceptor/api/create-interceptor-server `createInterceptorServer` API reference} */
 interface InterceptorServerOptions {
-    /**
-     * The hostname to start the server on.
-     *
-     * @default localhost
-     */
+    /** @see {@link https://zimic.dev/docs/interceptor/api/create-interceptor-server `createInterceptorServer` API reference} */
     hostname?: string;
-    /** The port to start the server on. If no port is provided, a random one is chosen. */
+    /** @see {@link https://zimic.dev/docs/interceptor/api/create-interceptor-server `createInterceptorServer` API reference} */
     port?: number;
-    /**
-     * Whether to log warnings about unhandled requests to the console.
-     *
-     * @default true
-     */
+    /** @see {@link https://zimic.dev/docs/interceptor/api/create-interceptor-server `createInterceptorServer` API reference} */
     logUnhandledRequests?: boolean;
-    /**
-     * The directory where the authorized interceptor authentication tokens are saved. If provided, only remote
-     * interceptors bearing a valid token will be accepted. This option is essential if you are exposing your interceptor
-     * server publicly. For local development and testing, though, `--tokens-dir` is optional.
-     *
-     * @default undefined
-     */
+    /** @see {@link https://zimic.dev/docs/interceptor/api/create-interceptor-server `createInterceptorServer` API reference} */
     tokensDirectory?: string;
 }
 
-/**
- * A server to intercept and handle requests. It is used in combination with
- * {@link https://zimic.dev/docs/interceptor/guides/http/remote-interceptors remote interceptors}.
- *
- * @see {@link https://zimic.dev/docs/interceptor/cli/server `zimic-interceptor server` API reference}
- */
+/** @see {@link https://zimic.dev/docs/interceptor/api/interceptor-server `InterceptorServer` API reference} */
 interface InterceptorServer {
-    /**
-     * The hostname of the server. It can be reassigned to a new value if the server is not running.
-     *
-     * @throws {RunningInterceptorServerError} When trying to reassign a new hostname with the server still running.
-     * @see {@link https://zimic.dev/docs/interceptor/cli/server `zimic-interceptor server` API reference}
-     */
+    /** @see {@link https://zimic.dev/docs/interceptor/api/interceptor-server `InterceptorServer` API reference} */
     hostname: string;
-    /**
-     * The port of the server. It can be reassigned to a new value if the server is not running.
-     *
-     * @throws {RunningInterceptorServerError} When trying to reassign a new port with the server still running.
-     * @see {@link https://zimic.dev/docs/interceptor/cli/server `zimic-interceptor server` API reference}
-     */
+    /** @see {@link https://zimic.dev/docs/interceptor/api/interceptor-server `InterceptorServer` API reference} */
     port: number | undefined;
-    /**
-     * Whether to log warnings about unhandled requests to the console.
-     *
-     * @default true
-     * @see {@link https://zimic.dev/docs/interceptor/cli/server `zimic-interceptor server` API reference}
-     */
+    /** @see {@link https://zimic.dev/docs/interceptor/api/interceptor-server `InterceptorServer` API reference} */
     logUnhandledRequests: boolean;
-    /**
-     * The directory where the authorized interceptor authentication tokens are saved. If provided, only remote
-     * interceptors bearing a valid token will be accepted. This option is essential if you are exposing your interceptor
-     * server publicly. For local development and testing, though, `--tokens-dir` is optional.
-     *
-     * @default undefined
-     */
+    /** @see {@link https://zimic.dev/docs/interceptor/api/interceptor-server `InterceptorServer` API reference} */
     tokensDirectory?: string;
     /**
-     * Whether the server is running.
-     *
      * @readonly
-     * @see {@link https://zimic.dev/docs/interceptor/cli/server `zimic-interceptor server` API reference}
+     * @see {@link https://zimic.dev/docs/interceptor/api/interceptor-server `InterceptorServer` API reference}
      */
     get isRunning(): boolean;
-    /**
-     * Starts the server.
-     *
-     * The server is automatically stopped if a process exit event is detected, such as SIGINT, SIGTERM, or an uncaught
-     * exception.
-     *
-     * @see {@link https://zimic.dev/docs/interceptor/cli/server `zimic-interceptor server` API reference}
-     */
+    /** @see {@link https://zimic.dev/docs/interceptor/api/interceptor-server `InterceptorServer` API reference} */
     start: () => Promise<void>;
-    /**
-     * Stops the server.
-     *
-     * @see {@link https://zimic.dev/docs/interceptor/cli/server `zimic-interceptor server` API reference}
-     */
+    /** @see {@link https://zimic.dev/docs/interceptor/api/interceptor-server `InterceptorServer` API reference} */
     stop: () => Promise<void>;
 }
 
@@ -113,14 +56,7 @@ declare const DEFAULT_ACCESS_CONTROL_HEADERS: Readonly<{
 /** The default status code for the preflight request. */
 declare const DEFAULT_PREFLIGHT_STATUS_CODE = 204;
 
-/**
- * Creates an {@link https://zimic.dev/docs/interceptor/cli/server interceptor server}.
- *
- * @param options The options to create the server.
- * @returns The created server.
- * @see {@link https://zimic.dev/docs/interceptor/cli/server-programmatic-usage `zimic-interceptor server` programmatic usage}
- * @see {@link https://zimic.dev/docs/interceptor/guides/http/remote-interceptors Remote HTTP Interceptors} .
- */
+/** @see {@link https://zimic.dev/docs/interceptor/api/create-interceptor-server `createInterceptorServer` API reference} */
 declare function createInterceptorServer(options?: InterceptorServerOptions): InterceptorServer;
 
 export { DEFAULT_ACCESS_CONTROL_HEADERS, DEFAULT_PREFLIGHT_STATUS_CODE, type InterceptorServer, type InterceptorServerOptions, NotRunningInterceptorServerError, RunningInterceptorServerError, createInterceptorServer };