@zimic/http 0.5.0 → 0.5.1-canary.1

package/src/formData/HttpFormData.ts

@@ -3,36 +3,11 @@ import { ArrayItemIfArray, ReplaceBy } from '@zimic/utils/types';
 
 import { HttpFormDataSchema, HttpFormDataSchemaName, HttpFormDataSerialized } from './types';
 
-/**
- * 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} */
 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>,
@@ -54,7 +29,7 @@ class HttpFormData<LooseSchema extends HttpFormDataSchema.Loose = HttpFormDataSc
     }
   }
 
-  /** @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>,
@@ -76,70 +51,55 @@ class HttpFormData<LooseSchema extends HttpFormDataSchema.Loose = HttpFormDataSc
     }
   }
 
-  /**
-   * 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> {
     return super.get(name) as never;
   }
 
-  /**
-   * 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>[] {
     return super.getAll(name) as never;
   }
 
-  /** @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 {
     return super.has(name);
   }
 
-  /** @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 {
     super.delete(name);
   }
 
+  /** @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,
-      parent: HttpFormData<this['_schema']>,
+      formData: HttpFormData<this['_schema']>,
     ) => void,
     thisArg?: This,
   ): void {
     super.forEach(callback as (value: FormDataEntryValue, key: string, parent: FormData) => void, thisArg);
   }
 
-  /** @see {@link https://developer.mozilla.org/docs/Web/API/FormData/keys MDN Reference} */
+  /** @see {@link https://zimic.dev/docs/http/api/http-form-data#formdatakeys `formData.keys()` API reference} */
   keys(): FormDataIterator<HttpFormDataSchemaName<this['_schema']>> {
     return super.keys() as never;
   }
 
-  /** @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>
   > {
     return super.values() as never;
   }
 
-  /** @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']>,
@@ -158,14 +118,7 @@ class HttpFormData<LooseSchema extends HttpFormDataSchema.Loose = HttpFormDataSc
     return super[Symbol.iterator]() as never;
   }
 
-  /**
-   * 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} */
   async equals<OtherSchema extends LooseSchema>(otherData: HttpFormData<OtherSchema>): Promise<boolean> {
     if (!(await this.contains(otherData))) {
       return false;
@@ -181,14 +134,7 @@ class HttpFormData<LooseSchema extends HttpFormDataSchema.Loose = HttpFormDataSc
     return true;
   }
 
-  /**
-   * 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} */
   async contains<OtherSchema extends LooseSchema>(otherData: HttpFormData<OtherSchema>): Promise<boolean> {
     for (const [otherKey, otherValue] of otherData.entries()) {
       const values = super.getAll.call(this, otherKey);
@@ -218,30 +164,7 @@ class HttpFormData<LooseSchema extends HttpFormDataSchema.Loose = HttpFormDataSc
     return true;
   }
 
-  /**
-   * 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() {
     const object = {} as this['_schema'];
 

package/src/headers/HttpHeaders.ts

@@ -11,26 +11,7 @@ function pickPrimitiveProperties<LooseSchema extends HttpHeadersSchema.Loose>(sc
   }, {});
 }
 
-/**
- * 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} */
 class HttpHeaders<LooseSchema extends HttpHeadersSchema.Loose = HttpHeadersSchema.Loose> extends Headers {
   readonly _schema!: HttpHeadersSerialized<LooseSchema>;
 
@@ -42,60 +23,61 @@ class HttpHeaders<LooseSchema extends HttpHeadersSchema.Loose = HttpHeadersSchem
     }
   }
 
-  /** @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 {
     super.set(name, value);
   }
 
-  /** @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 {
     super.append(name, value);
   }
 
-  /** @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> {
     return super.get(name) as never;
   }
 
-  /** @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>>[] {
     return super.getSetCookie() as never;
   }
 
-  /** @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 {
     return super.has(name);
   }
 
-  /** @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 {
     super.delete(name);
   }
 
+  /** @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,
-      parent: Headers,
+      headers: Headers,
     ) => void,
     thisArg?: This,
   ): void {
     super.forEach(callback as (value: string, key: string, parent: Headers) => void, thisArg);
   }
 
-  /** @see {@link https://developer.mozilla.org/docs/Web/API/Headers/keys MDN Reference} */
+  /** @see {@link https://zimic.dev/docs/http/api/http-headers#headerskeys `headers.keys()` API reference} */
   keys(): HeadersIterator<HttpHeadersSchemaName<this['_schema']>> {
     return super.keys() as never;
   }
 
-  /** @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> {
     return super.values() as never;
   }
 
-  /** @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']>,
@@ -114,13 +96,7 @@ class HttpHeaders<LooseSchema extends HttpHeadersSchema.Loose = HttpHeadersSchem
     return super[Symbol.iterator]() as never;
   }
 
-  /**
-   * 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 {
     if (!this.contains(otherHeaders)) {
       return false;
@@ -136,14 +112,7 @@ class HttpHeaders<LooseSchema extends HttpHeadersSchema.Loose = HttpHeadersSchem
     return true;
   }
 
-  /**
-   * 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 {
     for (const [key, otherValue] of otherHeaders.entries()) {
       const value = super.get.call(this, key);

package/src/headers/types.ts

@@ -19,7 +19,7 @@ export type HttpHeadersSchemaTuple<Schema extends HttpHeadersSchema.Loose = Http
   [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`}. */
 export type HttpHeadersInit<Schema extends HttpHeadersSchema.Loose = HttpHeadersSchema.Loose> =
   | Headers
   | Schema

package/src/searchParams/HttpSearchParams.ts

@@ -20,29 +20,7 @@ function pickPrimitiveProperties<Schema extends HttpSearchParamsSchema.Loose>(sc
   return schemaWithPrimitiveProperties;
 }
 
-/**
- * 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} */
 class HttpSearchParams<
   LooseSchema extends HttpSearchParamsSchema.Loose = HttpSearchParamsSchema.Loose,
 > extends URLSearchParams {
@@ -67,7 +45,7 @@ class HttpSearchParams<
     }
   }
 
-  /** @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]>>,
@@ -75,7 +53,7 @@ class HttpSearchParams<
     super.set(name, value);
   }
 
-  /** @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]>>,
@@ -83,37 +61,21 @@ class HttpSearchParams<
     super.append(name, value);
   }
 
-  /**
-   * 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> {
     return super.get(name) as never;
   }
 
-  /**
-   * 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]>>[] {
     return super.getAll(name) as never;
   }
 
-  /** @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]>>,
@@ -121,7 +83,7 @@ class HttpSearchParams<
     return super.has(name, value);
   }
 
-  /** @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]>>,
@@ -129,30 +91,31 @@ class HttpSearchParams<
     super.delete(name, value);
   }
 
+  /** @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,
-      parent: HttpSearchParams<this['_schema']>,
+      searchParams: HttpSearchParams<this['_schema']>,
     ) => void,
     thisArg?: This,
   ): void {
     super.forEach(callback as (value: string, key: string, parent: URLSearchParams) => void, thisArg);
   }
 
-  /** @see {@link https://developer.mozilla.org/docs/Web/API/URLSearchParams/keys MDN Reference} */
+  /** @see {@link https://zimic.dev/docs/http/api/http-search-params#searchparamskeys `searchParams.keys()` API reference} */
   keys(): URLSearchParamsIterator<HttpSearchParamsSchemaName<this['_schema']>> {
     return super.keys() as never;
   }
 
-  /** @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']>]>>
   > {
     return super.values() as never;
   }
 
-  /** @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']>,
@@ -171,25 +134,12 @@ class HttpSearchParams<
     return super[Symbol.iterator]() as never;
   }
 
-  /**
-   * 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 {
     return this.contains(otherParams) && this.size === otherParams.size;
   }
 
-  /**
-   * 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 {
     for (const [key, otherValue] of otherParams.entries()) {
       const values = super.getAll.call(this, key);
@@ -208,24 +158,7 @@ class HttpSearchParams<
     return true;
   }
 
-  /**
-   * 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() {
     const object = {} as this['_schema'];
 

package/src/searchParams/types.ts

@@ -18,10 +18,7 @@ export type HttpSearchParamsSchemaTuple<Schema extends HttpSearchParamsSchema.Lo
   [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`}. */
 export type HttpSearchParamsInit<Schema extends HttpSearchParamsSchema.Loose = HttpSearchParamsSchema.Loose> =
   | string
   | URLSearchParams

package/src/typegen/openapi/generate.ts

@@ -69,68 +69,18 @@ function normalizeRawNodes(rawNodes: ts.Node[], context: TypeTransformContext, o
   return normalizedNodes;
 }
 
-/**
- * The options to use when generating types from an OpenAPI schema.
- *
- * @see {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐typegen#generatetypesfromopenapioptions `generateTypesFromOpenAPI(options)` API reference}
- */
+/** @see {@link https://zimic.dev/docs/http/api/typegen#generatetypesfromopenapi  `generateTypesFromOpenAPI()` API reference} */
 export interface OpenAPITypegenOptions {
-  /**
-   * The path to a local OpenAPI schema file or an URL to fetch it. Version 3 is supported as YAML or JSON.
-   *
-   * @example
-   *   './schema.yaml';
-   *   'https://example.com/openapi/schema.yaml';
-   */
   input: string;
-  /**
-   * The path to write the generated types to. If not provided, the types will be written to stdout.
-   *
-   * @example
-   *   './schema.ts';
-   */
   output?: string;
-  /**
-   * The name of the service to use in the generated types.
-   *
-   * @example
-   *   'MyService';
-   */
   serviceName: string;
-  /** Whether to include comments in the generated types. */
   includeComments: boolean;
-  /**
-   * Whether to remove unused operations and components from the generated types. This is useful for reducing the size
-   * of the output file.
-   */
   prune: boolean;
-  /**
-   * One or more expressions to filter the types to generate. Filters must follow the format `<method> <path>`, where
-   * `<method>` is an HTTP method or `*`, and `<path>` is a literal path or a glob. Filters are case-sensitive regarding
-   * paths. Negative filters can be created by prefixing the expression with `!`. If more than one positive filter is
-   * provided, they will be combined with OR, while negative filters will be combined with AND.
-   *
-   * @example
-   *   ['GET /users', '* /users', 'GET,POST /users/*', 'DELETE /users/**\\/*', '!GET /notifications'];
-   */
   filters?: string[];
-  /**
-   * A path to a file containing filter expressions. One expression is expected per line and the format is the same as
-   * used in a `--filter` option. Comments are prefixed with `#`. A filter file can be used alongside additional
-   * `--filter` expressions.
-   *
-   * @example
-   *   './filters.txt';
-   */
   filterFile?: string;
 }
 
-/**
- * Generates TypeScript types from an OpenAPI schema.
- *
- * @param options The options to use when generating the types.
- * @see {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐typegen#generatetypesfromopenapioptions `generateTypesFromOpenAPI(options)` API reference}
- */
+/** @see {@link https://zimic.dev/docs/http/api/typegen#generatetypesfromopenapi  `generateTypesFromOpenAPI()` API reference} */
 async function generateTypesFromOpenAPI({
   input: inputFilePathOrURL,
   output: outputFilePath,