@zimic/http 0.5.1-canary.0 → 0.5.1-canary.2

package/dist/index.d.ts

@@ -162,70 +162,30 @@ type HttpFormDataSerialized<Type> = [Type] extends [never] ? never : Type extend
     [Key in keyof Type as IfNever<PrimitiveHttpFormDataSerialized<Type[Key]>, never, Key>]: PrimitiveHttpFormDataSerialized<Type[Key]>;
 } : never;
 
-/**
- * An extended HTTP form data object with a strictly-typed schema. Fully compatible with the built-in
- * {@link https://developer.mozilla.org/docs/Web/API/FormData `FormData`} class.
- *
- * **IMPORTANT**: the input of `HttpFormData` and all of its internal types must be declared inline or as a type aliases
- * (`type`). They cannot be interfaces.
- *
- * @example
- *   import { HttpFormData } from '@zimic/http';
- *
- *   const formData = new HttpFormData<{
- *     files: File[];
- *     description?: string;
- *   }>();
- *
- *   formData.append('file', new File(['content'], 'file.txt', { type: 'text/plain' }));
- *   formData.append('description', 'My file');
- *
- *   const files = formData.getAll('file');
- *   console.log(files); // [File { name: 'file.txt', type: 'text/plain' }]
- *
- *   const description = formData.get('description');
- *   console.log(description); // 'My file'
- *
- * @see {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐http#httpformdata `HttpFormData` API reference}
- */
+/** @see {@link https://zimic.dev/docs/http/api/http-form-data `HttpFormData` API reference} */
 declare class HttpFormData<LooseSchema extends HttpFormDataSchema.Loose = HttpFormDataSchema.Loose> extends FormData {
     readonly _schema: HttpFormDataSerialized<LooseSchema>;
-    /** @see {@link https://developer.mozilla.org/docs/Web/API/FormData/set MDN Reference} */
+    /** @see {@link https://zimic.dev/docs/http/api/http-form-data#formdataset `formData.set()` API reference} */
     set<Name extends HttpFormDataSchemaName<this['_schema']>>(name: Name, value: Exclude<ArrayItemIfArray<NonNullable<LooseSchema[Name]>>, Blob>): void;
     set<Name extends HttpFormDataSchemaName<this['_schema']>>(name: Name, blob: Exclude<ArrayItemIfArray<NonNullable<LooseSchema[Name]>>, string>, fileName?: string): void;
-    /** @see {@link https://developer.mozilla.org/docs/Web/API/FormData/append MDN Reference} */
+    /** @see {@link https://zimic.dev/docs/http/api/http-form-data#formdataappend `formData.append()` API reference} */
     append<Name extends HttpFormDataSchemaName<this['_schema']>>(name: Name, value: Exclude<ArrayItemIfArray<NonNullable<LooseSchema[Name]>>, Blob>): void;
     append<Name extends HttpFormDataSchemaName<this['_schema']>>(name: Name, blob: Exclude<ArrayItemIfArray<NonNullable<LooseSchema[Name]>>, string>, fileName?: string): void;
-    /**
-     * Get the value of the entry associated to a key name.
-     *
-     * If the key might have multiple values, use {@link HttpFormData#getAll} instead.
-     *
-     * @param name The name of the key to get the value of.
-     * @returns The value associated with the key name, or `null` if the key does not exist.
-     * @see {@link https://developer.mozilla.org/docs/Web/API/FormData/get MDN Reference}
-     */
+    /** @see {@link https://zimic.dev/docs/http/api/http-form-data#formdataget `formData.get()` API reference} */
     get<Name extends HttpFormDataSchemaName.NonArray<this['_schema']>>(name: Name): ReplaceBy<ReplaceBy<ArrayItemIfArray<this['_schema'][Name]>, undefined, null>, Blob, File>;
-    /**
-     * Get all the values of the entry associated with a key name.
-     *
-     * If the key has at most a single value, use {@link HttpFormData#get} instead.
-     *
-     * @param name The name of the key to get the values of.
-     * @returns An array of values associated with the key name, or an empty array if the key does not exist.
-     * @see {@link https://developer.mozilla.org/docs/Web/API/FormData/getAll MDN Reference}
-     */
+    /** @see {@link https://zimic.dev/docs/http/api/http-form-data#formdatagetall `formData.getAll()` API reference} */
     getAll<Name extends HttpFormDataSchemaName.Array<this['_schema']>>(name: Name): ReplaceBy<ArrayItemIfArray<NonNullable<this['_schema'][Name]>>, Blob, File>[];
-    /** @see {@link https://developer.mozilla.org/docs/Web/API/FormData/has MDN Reference} */
+    /** @see {@link https://zimic.dev/docs/http/api/http-form-data#formdatahas `formData.has()` API reference} */
     has<Name extends HttpFormDataSchemaName<this['_schema']>>(name: Name): boolean;
-    /** @see {@link https://developer.mozilla.org/docs/Web/API/FormData/delete MDN Reference} */
+    /** @see {@link https://zimic.dev/docs/http/api/http-form-data#formdatadelete `formData.delete()` API reference} */
     delete<Name extends HttpFormDataSchemaName<this['_schema']>>(name: Name): void;
-    forEach<This extends HttpFormData<this['_schema']>>(callback: <Key extends HttpFormDataSchemaName<this['_schema']>>(value: ReplaceBy<ArrayItemIfArray<NonNullable<this['_schema'][Key]>>, Blob, File>, key: Key, parent: HttpFormData<this['_schema']>) => void, thisArg?: This): void;
-    /** @see {@link https://developer.mozilla.org/docs/Web/API/FormData/keys MDN Reference} */
+    /** @see {@link https://zimic.dev/docs/http/api/http-form-data#formdataforEach `formData.forEach()` API reference} */
+    forEach<This extends HttpFormData<this['_schema']>>(callback: <Key extends HttpFormDataSchemaName<this['_schema']>>(value: ReplaceBy<ArrayItemIfArray<NonNullable<this['_schema'][Key]>>, Blob, File>, key: Key, formData: HttpFormData<this['_schema']>) => void, thisArg?: This): void;
+    /** @see {@link https://zimic.dev/docs/http/api/http-form-data#formdatakeys `formData.keys()` API reference} */
     keys(): FormDataIterator<HttpFormDataSchemaName<this['_schema']>>;
-    /** @see {@link https://developer.mozilla.org/docs/Web/API/FormData/values MDN Reference} */
+    /** @see {@link https://zimic.dev/docs/http/api/http-form-data#formdatavalues `formData.values()` API reference} */
     values(): FormDataIterator<ReplaceBy<ArrayItemIfArray<NonNullable<this['_schema'][HttpFormDataSchemaName<this['_schema']>]>>, Blob, File>>;
-    /** @see {@link https://developer.mozilla.org/docs/Web/API/FormData/entries MDN Reference} */
+    /** @see {@link https://zimic.dev/docs/http/api/http-form-data#formdataentries `formData.entries()` API reference} */
     entries(): FormDataIterator<[
         HttpFormDataSchemaName<this['_schema']>,
         ReplaceBy<ArrayItemIfArray<NonNullable<this['_schema'][HttpFormDataSchemaName<this['_schema']>]>>, Blob, File>
@@ -234,48 +194,11 @@ declare class HttpFormData<LooseSchema extends HttpFormDataSchema.Loose = HttpFo
         HttpFormDataSchemaName<this['_schema']>,
         ReplaceBy<ArrayItemIfArray<NonNullable<this['_schema'][HttpFormDataSchemaName<this['_schema']>]>>, Blob, File>
     ]>;
-    /**
-     * Checks if the data is equal to the other data. Equality is defined as having the same keys and values, regardless
-     * of the order of keys.
-     *
-     * @param otherData The other data to compare.
-     * @returns A promise that resolves with `true` if the data is equal to the other data, or `false` otherwise.
-     *   Important: both form data might be read while comparing.
-     */
+    /** @see {@link https://zimic.dev/docs/http/api/http-form-data#formdataequals `formData.equals()` API reference} */
     equals<OtherSchema extends LooseSchema>(otherData: HttpFormData<OtherSchema>): Promise<boolean>;
-    /**
-     * Checks if the data contains the other data. This method is less strict than {@link HttpFormData#equals} and only
-     * requires that all keys and values in the other data are present in this data.
-     *
-     * @param otherData The other data to compare.
-     * @returns A promise that resolves with `true` if this data contains the other data, or `false` otherwise. Important:
-     *   both form data might be read while comparing.
-     */
+    /** @see {@link https://zimic.dev/docs/http/api/http-form-data#formdatacontains `formData.contains()` API reference} */
     contains<OtherSchema extends LooseSchema>(otherData: HttpFormData<OtherSchema>): Promise<boolean>;
-    /**
-     * Converts this form data into a plain object. This method is useful for serialization and debugging purposes.
-     *
-     * **NOTE**: If a key has multiple values, the object will contain an array of values for that key. If the key has
-     * only one value, the object will contain its value directly, without an array, regardless of how the value was
-     * initialized when creating the form data.
-     *
-     * @example
-     *   const formData = new HttpFormData<{
-     *     title: string;
-     *     descriptions: string[];
-     *     content: Blob;
-     *   }>();
-     *
-     *   formData.set('title', 'My title');
-     *   formData.append('descriptions', 'Description 1');
-     *   formData.append('descriptions', 'Description 2');
-     *   formData.set('content', new Blob(['content'], { type: 'text/plain' }));
-     *
-     *   const object = formData.toObject();
-     *   console.log(object); // { title: 'My title', descriptions: ['Description 1', 'Description 2'], content: Blob { type: 'text/plain' } }
-     *
-     * @returns A plain object representation of this form data.
-     */
+    /** @see {@link https://zimic.dev/docs/http/api/http-form-data#formdatatoobject `formData.toObject()` API reference} */
     toObject(): this["_schema"];
 }
 
@@ -321,7 +244,7 @@ declare namespace HttpHeadersSchema {
 type HttpHeadersSchemaTuple<Schema extends HttpHeadersSchema.Loose = HttpHeadersSchema.Loose> = {
     [Key in keyof Schema & string]: [Key, NonNullable<Schema[Key]>];
 }[keyof Schema & string];
-/** An initialization value for {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐http#httpheaders `HttpHeaders`}. */
+/** An initialization value for {@link https://zimic.dev/docs/http/api/http-headers `HttpHeaders`}. */
 type HttpHeadersInit<Schema extends HttpHeadersSchema.Loose = HttpHeadersSchema.Loose> = Headers | Schema | HttpHeaders<Schema> | HttpHeadersSchemaTuple<Schema>[];
 /**
  * Extracts the names of the headers defined in a {@link HttpHeadersSchema}. Each key is considered a header name.
@@ -360,47 +283,29 @@ type HttpHeadersSchemaName<Schema extends HttpHeadersSchema> = IfNever<Schema, n
  */
 type HttpHeadersSerialized<Type> = HttpPathParamsSerialized<Type>;
 
-/**
- * An extended HTTP headers object with a strictly-typed schema. Fully compatible with the built-in
- * {@link https://developer.mozilla.org/docs/Web/API/Headers `Headers`} class.
- *
- * @example
- *   import { HttpHeaders } from '@zimic/http';
- *
- *   const headers = new HttpHeaders<{
- *     accept?: string;
- *     'content-type'?: string;
- *   }>({
- *     accept: '*',
- *     'content-type': 'application/json',
- *   });
- *
- *   const contentType = headers.get('content-type');
- *   console.log(contentType); // 'application/json'
- *
- * @see {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐http#httpheaders `HttpHeaders` API reference}
- */
+/** @see {@link https://zimic.dev/docs/http/api/http-headers `HttpHeaders` API reference} */
 declare class HttpHeaders<LooseSchema extends HttpHeadersSchema.Loose = HttpHeadersSchema.Loose> extends Headers {
     readonly _schema: HttpHeadersSerialized<LooseSchema>;
     constructor(init?: HttpHeadersInit<LooseSchema>);
-    /** @see {@link https://developer.mozilla.org/docs/Web/API/Headers/set MDN Reference} */
+    /** @see {@link https://zimic.dev/docs/http/api/http-headers#headersset `headers.set()` API reference} */
     set<Name extends HttpHeadersSchemaName<this['_schema']>>(name: Name, value: NonNullable<LooseSchema[Name]>): void;
-    /** @see {@link https://developer.mozilla.org/docs/Web/API/Headers/append MDN Reference} */
+    /** @see {@link https://zimic.dev/docs/http/api/http-headers#headersappend `headers.append()` API reference} */
     append<Name extends HttpHeadersSchemaName<this['_schema']>>(name: Name, value: NonNullable<LooseSchema[Name]>): void;
-    /** @see {@link https://developer.mozilla.org/docs/Web/API/Headers/get MDN Reference} */
+    /** @see {@link https://zimic.dev/docs/http/api/http-headers#headersget `headers.get()` API reference} */
     get<Name extends HttpHeadersSchemaName<this['_schema']>>(name: Name): ReplaceBy<this['_schema'][Name], undefined, null>;
-    /** @see {@link https://developer.mozilla.org/docs/Web/API/Headers/has MDN Reference} */
+    /** @see {@link https://zimic.dev/docs/http/api/http-headers#headersgetSetCookie `headers.getSetCookie()` API reference} */
     getSetCookie(): NonNullable<Default<this['_schema']['Set-Cookie'], string>>[];
-    /** @see {@link https://developer.mozilla.org/docs/Web/API/Headers/has MDN Reference} */
+    /** @see {@link https://zimic.dev/docs/http/api/http-headers#headershas `headers.has()` API reference} */
     has<Name extends HttpHeadersSchemaName<this['_schema']>>(name: Name): boolean;
-    /** @see {@link https://developer.mozilla.org/docs/Web/API/Headers/delete MDN Reference} */
+    /** @see {@link https://zimic.dev/docs/http/api/http-headers#headersdelete `headers.delete()` API reference} */
     delete<Name extends HttpHeadersSchemaName<this['_schema']>>(name: Name): void;
-    forEach<This extends HttpHeaders<this['_schema']>>(callback: <Key extends HttpHeadersSchemaName<this['_schema']>>(value: NonNullable<this['_schema'][Key]> & string, key: Key, parent: Headers) => void, thisArg?: This): void;
-    /** @see {@link https://developer.mozilla.org/docs/Web/API/Headers/keys MDN Reference} */
+    /** @see {@link https://zimic.dev/docs/http/api/http-headers#headersforEach `headers.forEach()` API reference} */
+    forEach<This extends HttpHeaders<this['_schema']>>(callback: <Key extends HttpHeadersSchemaName<this['_schema']>>(value: NonNullable<this['_schema'][Key]> & string, key: Key, headers: Headers) => void, thisArg?: This): void;
+    /** @see {@link https://zimic.dev/docs/http/api/http-headers#headerskeys `headers.keys()` API reference} */
     keys(): HeadersIterator<HttpHeadersSchemaName<this['_schema']>>;
-    /** @see {@link https://developer.mozilla.org/docs/Web/API/Headers/values MDN Reference} */
+    /** @see {@link https://zimic.dev/docs/http/api/http-headers#headersvalues `headers.values()` API reference} */
     values(): HeadersIterator<NonNullable<this['_schema'][HttpHeadersSchemaName<this['_schema']>]> & string>;
-    /** @see {@link https://developer.mozilla.org/docs/Web/API/Headers/entries MDN Reference} */
+    /** @see {@link https://zimic.dev/docs/http/api/http-headers#headersentries `headers.entries()` API reference} */
     entries(): HeadersIterator<[
         HttpHeadersSchemaName<this['_schema']>,
         NonNullable<this['_schema'][HttpHeadersSchemaName<this['_schema']>]> & string
@@ -409,36 +314,11 @@ declare class HttpHeaders<LooseSchema extends HttpHeadersSchema.Loose = HttpHead
         HttpHeadersSchemaName<this['_schema']>,
         NonNullable<this['_schema'][HttpHeadersSchemaName<this['_schema']>]> & string
     ]>;
-    /**
-     * Checks if this headers object is equal to another set of headers. Equality is defined as having the same keys and
-     * values, regardless of the order of keys.
-     *
-     * @param otherHeaders The other headers object to compare against.
-     * @returns `true` if the headers are equal, `false` otherwise.
-     */
+    /** @see {@link https://zimic.dev/docs/http/api/http-headers#headersequals `headers.equals()` API reference} */
     equals<OtherSchema extends LooseSchema>(otherHeaders: HttpHeaders<OtherSchema>): boolean;
-    /**
-     * Checks if this headers object contains another set of headers. This method is less strict than
-     * {@link HttpHeaders#equals} and only requires that all keys and values in the other headers are present in these
-     * headers.
-     *
-     * @param otherHeaders The other headers object to compare against.
-     * @returns `true` if these headers contain the other headers, `false` otherwise.
-     */
+    /** @see {@link https://zimic.dev/docs/http/api/http-headers#headerscontains `headers.contains()` API reference} */
     contains<OtherSchema extends LooseSchema>(otherHeaders: HttpHeaders<OtherSchema>): boolean;
-    /**
-     * Converts these headers into a plain object. This method is useful for serialization and debugging purposes.
-     *
-     * @example
-     *   const headers = new HttpHeaders({
-     *     accept: 'application/json',
-     *     'content-type': 'application/json',
-     *   });
-     *   const object = headers.toObject();
-     *   console.log(object); // { accept: 'application/json', 'content-type': 'application/json' }
-     *
-     * @returns A plain object representation of these headers.
-     */
+    /** @see {@link https://zimic.dev/docs/http/api/http-headers#headerstoobject `headers.toObject()` API reference} */
     toObject(): this['_schema'];
     private splitHeaderValues;
 }
@@ -455,10 +335,7 @@ declare namespace HttpSearchParamsSchema {
 type HttpSearchParamsSchemaTuple<Schema extends HttpSearchParamsSchema.Loose = HttpSearchParamsSchema.Loose> = {
     [Key in keyof Schema & string]: [Key, ArrayItemIfArray<NonNullable<Schema[Key]>>];
 }[keyof Schema & string];
-/**
- * An initialization value for
- * {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐http#httpsearchparams `HttpSearchParams`}.
- */
+/** An initialization value for {@link https://zimic.dev/docs/http/api/http-search-params `HttpSearchParams`}. */
 type HttpSearchParamsInit<Schema extends HttpSearchParamsSchema.Loose = HttpSearchParamsSchema.Loose> = string | URLSearchParams | Schema | HttpSearchParams<Schema> | HttpSearchParamsSchemaTuple<Schema>[];
 declare namespace HttpSearchParamsSchemaName {
     /** Extracts the names of the search params defined in a {@link HttpSearchParamsSchema} that are arrays. */
@@ -523,67 +400,30 @@ type HttpSearchParamsSerialized<Type> = [Type] extends [never] ? never : Type ex
     [Key in keyof Type as IfNever<PrimitiveHttpSearchParamsSerialized<Type[Key]>, never, Key>]: PrimitiveHttpSearchParamsSerialized<Type[Key]>;
 } : never;
 
-/**
- * An extended HTTP search params object with a strictly-typed schema. Fully compatible with the built-in
- * {@link https://developer.mozilla.org/docs/Web/API/URLSearchParams `URLSearchParams`} class.
- *
- * @example
- *   import { HttpSearchParams } from '@zimic/http';
- *
- *   const searchParams = new HttpSearchParams<{
- *     names?: string[];
- *     page?: `${number}`;
- *   }>({
- *     names: ['user 1', 'user 2'],
- *     page: '1',
- *   });
- *
- *   const names = searchParams.getAll('names');
- *   console.log(names); // ['user 1', 'user 2']
- *
- *   const page = searchParams.get('page');
- *   console.log(page); // '1'
- *
- * @see {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐http#httpsearchparams `HttpSearchParams` API reference}
- */
+/** @see {@link https://zimic.dev/docs/http/api/http-search-params `HttpSearchParams` API reference} */
 declare class HttpSearchParams<LooseSchema extends HttpSearchParamsSchema.Loose = HttpSearchParamsSchema.Loose> extends URLSearchParams {
     readonly _schema: HttpSearchParamsSerialized<LooseSchema>;
     constructor(init?: HttpSearchParamsInit<LooseSchema>);
     private populateInitArrayProperties;
-    /** @see {@link https://developer.mozilla.org/docs/Web/API/URLSearchParams/set MDN Reference} */
+    /** @see {@link https://zimic.dev/docs/http/api/http-search-params#searchparamsset `searchParams.set()` API reference} */
     set<Name extends HttpSearchParamsSchemaName<this['_schema']>>(name: Name, value: ArrayItemIfArray<NonNullable<LooseSchema[Name]>>): void;
-    /** @see {@link https://developer.mozilla.org/docs/Web/API/URLSearchParams/append MDN Reference} */
+    /** @see {@link https://zimic.dev/docs/http/api/http-search-params#searchparamsappend `searchParams.append()` API reference} */
     append<Name extends HttpSearchParamsSchemaName<this['_schema']>>(name: Name, value: ArrayItemIfArray<NonNullable<LooseSchema[Name]>>): void;
-    /**
-     * Get the value of the entry associated to a key name.
-     *
-     * If the key might have multiple values, use {@link HttpSearchParams#getAll} instead.
-     *
-     * @param name The name of the key to get the value of.
-     * @returns The value associated with the key name, or `null` if the key does not exist.
-     * @see {@link https://developer.mozilla.org/docs/Web/API/URLSearchParams/get MDN Reference}
-     */
+    /** @see {@link https://zimic.dev/docs/http/api/http-search-params#searchparamsget `searchParams.get()` API reference} */
     get<Name extends HttpSearchParamsSchemaName.NonArray<this['_schema']>>(name: Name): ReplaceBy<ArrayItemIfArray<this['_schema'][Name]>, undefined, null>;
-    /**
-     * Get all the values of the entry associated with a key name.
-     *
-     * If the key has at most one value, use {@link HttpSearchParams#get} instead.
-     *
-     * @param name The name of the key to get the values of.
-     * @returns An array of values associated with the key name, or an empty array if the key does not exist.
-     * @see {@link https://developer.mozilla.org/docs/Web/API/URLSearchParams/getAll MDN Reference}
-     */
+    /** @see {@link https://zimic.dev/docs/http/api/http-search-params#searchparamsgetall `searchParams.getAll()` API reference} */
     getAll<Name extends HttpSearchParamsSchemaName.Array<this['_schema']>>(name: Name): ArrayItemIfArray<NonNullable<this['_schema'][Name]>>[];
-    /** @see {@link https://developer.mozilla.org/docs/Web/API/URLSearchParams/has MDN Reference} */
+    /** @see {@link https://zimic.dev/docs/http/api/http-search-params#searchparamshas `searchParams.has()` API reference} */
     has<Name extends HttpSearchParamsSchemaName<this['_schema']>>(name: Name, value?: ArrayItemIfArray<NonNullable<LooseSchema[Name]>>): boolean;
-    /** @see {@link https://developer.mozilla.org/docs/Web/API/URLSearchParams/delete MDN Reference} */
+    /** @see {@link https://zimic.dev/docs/http/api/http-search-params#searchparamsdelete `searchParams.delete()` API reference} */
     delete<Name extends HttpSearchParamsSchemaName<this['_schema']>>(name: Name, value?: ArrayItemIfArray<NonNullable<LooseSchema[Name]>>): void;
-    forEach<This extends HttpSearchParams<this['_schema']>>(callback: <Key extends HttpSearchParamsSchemaName<this['_schema']>>(value: ArrayItemIfArray<NonNullable<this['_schema'][Key]>>, key: Key, parent: HttpSearchParams<this['_schema']>) => void, thisArg?: This): void;
-    /** @see {@link https://developer.mozilla.org/docs/Web/API/URLSearchParams/keys MDN Reference} */
+    /** @see {@link https://zimic.dev/docs/http/api/http-search-params#searchparamsforEach `searchParams.forEach()` API reference} */
+    forEach<This extends HttpSearchParams<this['_schema']>>(callback: <Key extends HttpSearchParamsSchemaName<this['_schema']>>(value: ArrayItemIfArray<NonNullable<this['_schema'][Key]>>, key: Key, searchParams: HttpSearchParams<this['_schema']>) => void, thisArg?: This): void;
+    /** @see {@link https://zimic.dev/docs/http/api/http-search-params#searchparamskeys `searchParams.keys()` API reference} */
     keys(): URLSearchParamsIterator<HttpSearchParamsSchemaName<this['_schema']>>;
-    /** @see {@link https://developer.mozilla.org/docs/Web/API/URLSearchParams/values MDN Reference} */
+    /** @see {@link https://zimic.dev/docs/http/api/http-search-params#searchparamsvalues `searchParams.values()` API reference} */
     values(): URLSearchParamsIterator<ArrayItemIfArray<NonNullable<this['_schema'][HttpSearchParamsSchemaName<this['_schema']>]>>>;
-    /** @see {@link https://developer.mozilla.org/docs/Web/API/URLSearchParams/entries MDN Reference} */
+    /** @see {@link https://zimic.dev/docs/http/api/http-search-params#searchparamsentries `searchParams.entries()` API reference} */
     entries(): URLSearchParamsIterator<[
         HttpSearchParamsSchemaName<this['_schema']>,
         ArrayItemIfArray<NonNullable<this['_schema'][HttpSearchParamsSchemaName<this['_schema']>]>>
@@ -592,41 +432,11 @@ declare class HttpSearchParams<LooseSchema extends HttpSearchParamsSchema.Loose
         HttpSearchParamsSchemaName<this['_schema']>,
         ArrayItemIfArray<NonNullable<this['_schema'][HttpSearchParamsSchemaName<this['_schema']>]>>
     ]>;
-    /**
-     * Checks if these search params are equal to another set of search parameters. Equality is defined as having the same
-     * keys and values, regardless of the order of the keys.
-     *
-     * @param otherParams The other search parameters to compare against.
-     * @returns `true` if the search parameters are equal, `false` otherwise.
-     */
+    /** @see {@link https://zimic.dev/docs/http/api/http-search-params#searchparamsequals `searchParams.equals()` API reference} */
     equals<OtherSchema extends LooseSchema>(otherParams: HttpSearchParams<OtherSchema>): boolean;
-    /**
-     * Checks if these search params contain another set of search parameters. This method is less strict than
-     * {@link HttpSearchParams#equals} and only requires that all keys and values in the other search parameters are
-     * present in these search parameters.
-     *
-     * @param otherParams The other search parameters to check for containment.
-     * @returns `true` if these search parameters contain the other search parameters, `false` otherwise.
-     */
+    /** @see {@link https://zimic.dev/docs/http/api/http-search-params#searchparamscontains `searchParams.contains()` API reference} */
     contains<OtherSchema extends LooseSchema>(otherParams: HttpSearchParams<OtherSchema>): boolean;
-    /**
-     * Converts these search params into a plain object. This method is useful for serialization and debugging purposes.
-     *
-     * **NOTE**: If a key has multiple values, the object will contain an array of values for that key. If the key has
-     * only one value, the object will contain its value directly, without an array, regardless of how the value was
-     * initialized when creating the search params object.
-     *
-     * @example
-     *   const searchParams = new HttpSearchParams({
-     *     names: ['user 1', 'user 2'],
-     *     name: ['user 3'],
-     *     page: '1',
-     *   });
-     *   const object = searchParams.toObject();
-     *   console.log(object); // { names: ['user 1', 'user 2'], name: 'user 3', page: '1' }
-     *
-     * @returns A plain object representation of these search params.
-     */
+    /** @see {@link https://zimic.dev/docs/http/api/http-search-params#searchparamstoobject `searchParams.toObject()` API reference} */
     toObject(): this["_schema"];
 }
 
@@ -639,7 +449,7 @@ type HttpMethod = (typeof HTTP_METHODS)[number];
 /**
  * A schema representing the structure of an HTTP request.
  *
- * @see {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐http‐schemas Declaring HTTP interceptor schemas}
+ * @see {@link https://zimic.dev/docs/http/api/http-schema `HttpSchema` API reference}
  */
 interface HttpRequestSchema {
     headers?: HttpHeadersSchema.Loose;
@@ -649,7 +459,7 @@ interface HttpRequestSchema {
 /**
  * A schema representing the structure of an HTTP response.
  *
- * @see {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐http‐schemas Declaring HTTP interceptor schemas}
+ * @see {@link https://zimic.dev/docs/http/api/http-schema `HttpSchema` API reference}
  */
 interface HttpResponseSchema {
     headers?: HttpHeadersSchema.Loose;
@@ -701,7 +511,7 @@ declare namespace HttpStatusCode {
 /**
  * A schema representing the structure of HTTP responses by status code.
  *
- * @see {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐http‐schemas Declaring HTTP interceptor schemas}
+ * @see {@link https://zimic.dev/docs/http/api/http-schema `HttpSchema` API reference}
  */
 type HttpResponseSchemaByStatusCode = {
     [StatusCode in HttpStatusCode]?: HttpResponseSchema;
@@ -709,13 +519,13 @@ type HttpResponseSchemaByStatusCode = {
 /**
  * Extracts the status codes used in a response schema by status code.
  *
- * @see {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐http‐schemas Declaring HTTP interceptor schemas}
+ * @see {@link https://zimic.dev/docs/http/api/http-schema `HttpSchema` API reference}
  */
 type HttpResponseSchemaStatusCode<ResponseSchemaByStatusCode extends HttpResponseSchemaByStatusCode> = keyof ResponseSchemaByStatusCode & HttpStatusCode;
 /**
  * A schema representing the structure of an HTTP request and response for a given method.
  *
- * @see {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐http‐schemas Declaring HTTP interceptor schemas}
+ * @see {@link https://zimic.dev/docs/http/api/http-schema `HttpSchema` API reference}
  */
 interface HttpMethodSchema {
     request?: HttpRequestSchema;
@@ -724,7 +534,7 @@ interface HttpMethodSchema {
 /**
  * A schema representing the structure of HTTP request and response by method.
  *
- * @see {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐http‐schemas Declaring HTTP interceptor schemas}
+ * @see {@link https://zimic.dev/docs/http/api/http-schema `HttpSchema` API reference}
  */
 interface HttpMethodsSchema {
     GET?: HttpMethodSchema;
@@ -738,363 +548,47 @@ interface HttpMethodsSchema {
 interface BaseHttpSchema {
     [path: string]: HttpMethodsSchema;
 }
-/**
- * Declares an HTTP service schema.
- *
- * @example
- *   import { type HttpSchema } from '@zimic/http';
- *
- *   interface UserListHeaders {
- *     accept: string;
- *   }
- *
- *   interface UserListSearchParams {
- *     name?: string;
- *     limit?: number;
- *   }
- *
- *   type Schema = HttpSchema<{
- *     '/users': {
- *       GET: {
- *         request: {
- *           headers: UserListHeaders;
- *           searchParams: UserListSearchParams;
- *         };
- *         response: {
- *           200: {
- *             // Inline headers declaration
- *             headers: { 'content-type': string };
- *             body: User[];
- *           };
- *         };
- *       };
- *     };
- *   }>;
- *
- * @see {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐http‐schemas Declaring HTTP interceptor schemas}
- */
+/** @see {@link https://zimic.dev/docs/http/api/http-schema `HttpSchema` API reference} */
 type HttpSchema<Schema extends BaseHttpSchema = BaseHttpSchema> = Branded<Schema, 'HttpSchema'>;
 declare namespace HttpSchema {
-    /**
-     * Declares an HTTP service methods schema.
-     *
-     * @example
-     *   import { type HttpSchema } from '@zimic/http';
-     *
-     *   type UserMethods = HttpSchema.Methods<{
-     *     GET: {
-     *       response: {
-     *         200: { body: User[] };
-     *       };
-     *     };
-     *   }>;
-     *
-     *   type Schema = HttpSchema<{
-     *     '/users': UserMethods;
-     *   }>;
-     */
+    /** @see {@link https://zimic.dev/docs/http/api/http-schema#httpschemamethods `HttpSchema.Methods` API reference} */
     type Methods<Schema extends HttpMethodsSchema> = Schema;
-    /**
-     * Declares an HTTP service method schema.
-     *
-     * @example
-     *   import { type HttpSchema } from '@zimic/http';
-     *
-     *   type UserListMethod = HttpSchema.Method<{
-     *     response: {
-     *       200: { body: User[] };
-     *     };
-     *   }>;
-     *
-     *   type Schema = HttpSchema<{
-     *     '/users': {
-     *       GET: UserListMethod;
-     *     };
-     *   }>;
-     */
+    /** @see {@link https://zimic.dev/docs/http/api/http-schema#httpschemamethod `HttpSchema.Method` API reference} */
     type Method<Schema extends HttpMethodSchema> = Schema;
-    /**
-     * Declares an HTTP service request schema.
-     *
-     * @example
-     *   import { type HttpSchema } from '@zimic/http';
-     *
-     *   type UserCreationRequest = HttpSchema.Request<{
-     *     headers: { 'content-type': 'application/json' };
-     *     body: User;
-     *   }>;
-     *
-     *   type Schema = HttpSchema<{
-     *     '/users': {
-     *       POST: {
-     *         request: UserCreationRequest;
-     *         response: {
-     *           201: { body: User };
-     *         };
-     *       };
-     *     };
-     *   }>;
-     */
+    /** @see {@link https://zimic.dev/docs/http/api/http-schema#httpschemarequest `HttpSchema.Request` API reference} */
     type Request<Schema extends HttpRequestSchema> = Schema;
-    /**
-     * Declares an HTTP service response schema by status code.
-     *
-     * @example
-     *   import { type HttpSchema } from '@zimic/http';
-     *
-     *   type UserListResponseByStatusCode = HttpSchema.ResponseByStatusCode<{
-     *     200: { body: User[] };
-     *     400: { body: { message: string } };
-     *   }>;
-     *
-     *   type Schema = HttpSchema<{
-     *     '/users': {
-     *       GET: {
-     *         response: UserListResponseByStatusCode;
-     *       };
-     *     };
-     *   }>;
-     */
+    /** @see {@link https://zimic.dev/docs/http/api/http-schema#httpschemaresponsebystatuscode `HttpSchema.ResponseByStatusCode` API reference} */
     type ResponseByStatusCode<Schema extends HttpResponseSchemaByStatusCode> = Schema;
-    /**
-     * Declares an HTTP service response schema.
-     *
-     * @example
-     *   import { type HttpSchema } from '@zimic/http';
-     *
-     *   type UserListSuccessResponse = HttpSchema.Response<{
-     *     body: User[];
-     *   }>;
-     *
-     *   type Schema = HttpSchema<{
-     *     '/users': {
-     *       GET: {
-     *         response: {
-     *           200: UserListSuccessResponse;
-     *         };
-     *       };
-     *     };
-     *   }>;
-     */
+    /** @see {@link https://zimic.dev/docs/http/api/http-schema#httpschemaresponse  `HttpSchema.Response` API reference} */
     type Response<Schema extends HttpResponseSchema> = Schema;
-    /**
-     * Declares an HTTP body schema.
-     *
-     * @example
-     *   import { type HttpSchema } from '@zimic/http';
-     *
-     *   type UserListSuccessResponseBody = HttpSchema.Body<User[]>;
-     *
-     *   type Schema = HttpSchema<{
-     *     '/users': {
-     *       GET: {
-     *         response: {
-     *           200: { body: UserListSuccessResponseBody };
-     *         };
-     *       };
-     *     };
-     *   }>;
-     */
+    /** @see {@link https://zimic.dev/docs/http/api/http-schema#httpschemabody `HttpSchema.Body` API reference} */
     type Body<Schema extends HttpBody.Loose> = Schema;
-    /**
-     * Declares an HTTP headers schema.
-     *
-     * @example
-     *   import { type HttpSchema } from '@zimic/http';
-     *
-     *   type UserListHeaders = HttpSchema.Headers<{
-     *     accept: 'application/json';
-     *   }>;
-     *
-     *   type Schema = HttpSchema<{
-     *     '/users': {
-     *       GET: {
-     *         request: {
-     *           headers: UserListHeaders;
-     *         };
-     *         response: {
-     *           200: { body: User[] };
-     *         };
-     *       };
-     *     };
-     *   }>;
-     */
+    /** @see {@link https://zimic.dev/docs/http/api/http-schema#httpschemaheaders `HttpSchema.Headers` API reference} */
     type Headers<Schema extends HttpHeadersSchema.Loose> = Schema;
-    /**
-     * Declares an HTTP search params schema.
-     *
-     * @example
-     *   import { type HttpSchema } from '@zimic/http';
-     *
-     *   type UserListSearchParams = HttpSchema.SearchParams<{
-     *     limit: `${number}`;
-     *     offset: `${number}`;
-     *   }>;
-     *
-     *   type Schema = HttpSchema<{
-     *     '/users': {
-     *       GET: {
-     *         request: {
-     *           searchParams: UserListSearchParams;
-     *         };
-     *         response: {
-     *           200: { body: User[] };
-     *         };
-     *       };
-     *     };
-     *   }>;
-     */
+    /** @see {@link https://zimic.dev/docs/http/api/http-schema#httpschemasearchparams `HttpSchema.SearchParams` API reference} */
     type SearchParams<Schema extends HttpSearchParamsSchema.Loose> = Schema;
-    /**
-     * Declares an HTTP path params schema.
-     *
-     * @example
-     *   import { type HttpSchema, InferPathParams } from '@zimic/http';
-     *
-     *   type Schema = HttpSchema<{
-     *     '/users/:userId': {
-     *       GET: {
-     *         response: {
-     *           200: { body: User };
-     *         };
-     *       };
-     *     };
-     *   }>;
-     *
-     *   type UserByIdPathParams = HttpSchema.PathParams<{
-     *     userId: string;
-     *   }>;
-     *
-     *   // Or infer from the path string
-     *   type UserByIdPathParams = InferPathParams<Schema, '/users/:userId'>;
-     */
+    /** @see {@link https://zimic.dev/docs/http/api/http-schema#httpschemapathparams `HttpSchema.PathParams` API reference} */
     type PathParams<Schema extends HttpPathParamsSchema.Loose> = Schema;
-    /**
-     * Declares an HTTP form data schema.
-     *
-     * @example
-     *   import { HttpFormData, type HttpSchema } from '@zimic/http';
-     *
-     *   type UserCreationFormData = HttpFormData<
-     *     HttpSchema.FormData<{
-     *       name: string;
-     *       email: string;
-     *     }>
-     *   >;
-     *
-     *   type Schema = HttpSchema<{
-     *     '/users': {
-     *       POST: {
-     *         request: {
-     *           body: UserCreationFormData;
-     *         };
-     *         response: {
-     *           201: { body: User };
-     *         };
-     *       };
-     *     };
-     *   }>;
-     */
+    /** @see {@link https://zimic.dev/docs/http/api/http-schema#httpschemaformdata `HttpSchema.FormData` API reference} */
     type FormData<Schema extends HttpFormDataSchema.Loose> = Schema;
 }
 /**
  * Extracts the methods from an HTTP service schema.
  *
- * @see {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐http‐schemas Declaring HTTP interceptor schemas}
+ * @see {@link https://zimic.dev/docs/http/api/http-schema `HttpSchema` API reference}
  */
 type HttpSchemaMethod<Schema extends HttpSchema> = IfAny<Schema, any, // eslint-disable-line @typescript-eslint/no-explicit-any
 // eslint-disable-line @typescript-eslint/no-explicit-any
 keyof UnionToIntersection<Schema[keyof Schema]> & HttpMethod>;
 type AllowAnyStringInPathParams<Path extends string> = Path extends `${infer Prefix}:${string}/${infer Suffix}` ? `${Prefix}${string}/${AllowAnyStringInPathParams<Suffix>}` : Path extends `${infer Prefix}:${string}` ? `${Prefix}${string}` : Path;
-/**
- * Extracts the paths from an HTTP service schema. Optionally receives a second argument with one or more methods to
- * filter the paths with. Only the methods defined in the schema are allowed.
- *
- * @example
- *   import { type HttpSchema, type HttpSchemaPath } from '@zimic/http';
- *
- *   type Schema = HttpSchema<{
- *     '/users': {
- *       GET: {
- *         response: { 200: { body: User[] } };
- *       };
- *     };
- *     '/users/:userId': {
- *       DELETE: {
- *         response: { 200: { body: User } };
- *       };
- *     };
- *   }>;
- *
- *   type Path = HttpSchemaPath<Schema>;
- *   // "/users" | "/users/:userId" | "/users/${string}"
- *
- *   type GetPath = HttpSchemaPath<Schema, 'GET'>;
- *   // "/users"
- *
- * @see {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐http‐schemas Declaring HTTP interceptor schemas}
- */
+/** @see {@link https://zimic.dev/docs/http/api/http-schema#httpschemapath `HttpSchemaPath` API reference} */
 declare namespace HttpSchemaPath {
     type LooseLiteral<Schema extends HttpSchema, Method extends HttpMethod = HttpMethod> = {
         [Path in keyof Schema & string]: Method extends keyof Schema[Path] ? Path : never;
     }[keyof Schema & string];
-    /**
-     * Extracts the literal paths from an HTTP service schema. Optionally receives a second argument with one or more
-     * methods to filter the paths with. Only the methods defined in the schema are allowed.
-     *
-     * @example
-     *   import { type HttpSchema, type HttpSchemaPath } from '@zimic/http';
-     *
-     *   type Schema = HttpSchema<{
-     *     '/users': {
-     *       GET: {
-     *         response: { 200: { body: User[] } };
-     *       };
-     *     };
-     *     '/users/:userId': {
-     *       DELETE: {
-     *         response: { 200: { body: User } };
-     *       };
-     *     };
-     *   }>;
-     *
-     *   type LiteralPath = HttpSchemaPath.Literal<Schema>;
-     *   // "/users" | "/users/:userId"
-     *
-     *   type LiteralGetPath = HttpSchemaPath.Literal<Schema, 'GET'>;
-     *   // "/users"
-     *
-     * @see {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐http‐schemas Declaring HTTP interceptor schemas}
-     */
+    /** @see {@link https://zimic.dev/docs/http/api/http-schema#httpschemapathliteral `HttpSchemaPath.Literal` API reference} */
     export type Literal<Schema extends HttpSchema, Method extends HttpSchemaMethod<Schema> = HttpSchemaMethod<Schema>> = LooseLiteral<Schema, Method>;
-    /**
-     * Extracts the non-literal paths from an HTTP service schema. Optionally receives a second argument with one or more
-     * methods to filter the paths with. Only the methods defined in the schema are allowed.
-     *
-     * @example
-     *   import { type HttpSchema, type HttpSchemaPath } from '@zimic/http';
-     *
-     *   type Schema = HttpSchema<{
-     *     '/users': {
-     *       GET: {
-     *         response: { 200: { body: User[] } };
-     *       };
-     *     };
-     *     '/users/:userId': {
-     *       DELETE: {
-     *         response: { 200: { body: User } };
-     *       };
-     *     };
-     *   }>;
-     *
-     *   type NonLiteralPath = HttpSchemaPath.NonLiteral<Schema>;
-     *   // "/users" | "/users/${string}"
-     *
-     *   type NonLiteralGetPath = HttpSchemaPath.NonLiteral<Schema, 'GET'>;
-     *   // "/users"
-     *
-     * @see {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐http‐schemas Declaring HTTP interceptor schemas}
-     */
+    /** @see {@link https://zimic.dev/docs/http/api/http-schema#httpschemapathnonliteral `HttpSchemaPath.NonLiteral` API reference} */
     export type NonLiteral<Schema extends HttpSchema, Method extends HttpSchemaMethod<Schema> = HttpSchemaMethod<Schema>> = AllowAnyStringInPathParams<Literal<Schema, Method>>;
     export {  };
 }
@@ -1109,69 +603,10 @@ type RecursiveInferPathParams<Path extends string> = Path extends `${infer _Pref
 } & RecursiveInferPathParams<Suffix> : Path extends `${infer _Prefix}:${infer ParamName}` ? {
     [Name in ParamName]: string;
 } : {};
-/**
- * Infers the path parameters schema from a path string, optionally validating it against an {@link HttpSchema}.
- *
- * If the first argument is a {@link HttpSchema} (recommended), the second argument is checked to be a valid path in that
- * schema.
- *
- * @example
- *   import { HttpSchema, InferPathParams } from '@zimic/http';
- *
- *   type Schema = HttpSchema<{
- *     '/users/:userId': {
- *       GET: {
- *         response: { 200: { body: User } };
- *       };
- *     };
- *   }>;
- *
- *   // Using a schema to validate the path (recommended):
- *   type PathParams = InferPathParams<Schema, '/users/:userId'>;
- *   // { userId: string }
- *
- * @example
- *   import { InferPathParams } from '@zimic/http';
- *
- *   // Without using a schema to validate the path (works as `PathParamsSchemaFromPath`):
- *   type PathParams = InferPathParams<'/users/:userId'>;
- *   // { userId: string }
- */
+/** @see {@link https://zimic.dev/docs/http/api/http-schema#inferpathparams `InferPathParams` API reference} */
 type InferPathParams<PathOrSchema extends string | HttpSchema, OptionalPath extends PathOrSchema extends HttpSchema ? HttpSchemaPath.Literal<PathOrSchema> : never = never> = Prettify<RecursiveInferPathParams<PathOrSchema extends HttpSchema ? OptionalPath : PathOrSchema extends string ? PathOrSchema : never>>;
 type OmitPastHttpStatusCodes<Schema extends HttpResponseSchemaByStatusCode, PastSchemas extends HttpResponseSchemaByStatusCode[]> = PastSchemas extends NonEmptyArray<HttpResponseSchemaByStatusCode> ? Omit<Schema, keyof UnionToIntersection<PastSchemas[number]>> : Schema;
-/**
- * Merges multiple HTTP response schemas by status code into a single schema. When there are duplicate status codes, the
- * first declaration takes precedence.
- *
- * @example
- *   import { type HttpSchema, type HttpStatusCode, MergeHttpResponsesByStatusCode } from '@zimic/http';
- *
- *   // Overriding the 400 status code with a more specific schema
- *   // and using a generic schema for all other client errors.
- *   type MergedResponseByStatusCode = MergeHttpResponsesByStatusCode<
- *     [
- *       {
- *         400: { body: { message: string; issues: string[] } };
- *       },
- *       {
- *         [StatusCode in HttpStatusCode.ClientError]: { body: { message: string } };
- *       },
- *     ]
- *   >;
- *   // {
- *   //   400: { body: { message: string; issues: string[] } };
- *   //   401: { body: { message: string}; };
- *   //   402: { body: { message: string}; };
- *   //   403: { body: { message: string}; };
- *   //   ...
- *   // }
- *
- *   type Schema = HttpSchema<{
- *     '/users': {
- *       GET: { response: MergedResponseByStatusCode };
- *     };
- *   }>;
- */
+/** @see {@link https://zimic.dev/docs/http/api/http-schema#mergehttpresponsesbystatuscode `MergeHttpResponsesByStatusCode` API reference} */
 type MergeHttpResponsesByStatusCode<Schemas extends HttpResponseSchemaByStatusCode[], PastSchemas extends HttpResponseSchemaByStatusCode[] = []> = Schemas extends [
     infer FirstSchema extends HttpResponseSchemaByStatusCode,
     ...infer RestSchemas extends HttpResponseSchemaByStatusCode[]