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

package/dist/index.js

@@ -84,64 +84,42 @@ var HttpFormData = class extends FormData {
       super.append(name, blobOrValue, fileName);
     }
   }
-  /**
-   * 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) {
     return super.get(name);
   }
-  /**
-   * 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) {
     return super.getAll(name);
   }
-  /** @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) {
     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) {
     super.delete(name);
   }
+  /** @see {@link https://zimic.dev/docs/http/api/http-form-data#formdataforEach `formData.forEach()` API reference} */
   forEach(callback, thisArg) {
     super.forEach(callback, 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() {
     return super.keys();
   }
-  /** @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() {
     return super.values();
   }
-  /** @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() {
     return super.entries();
   }
   [Symbol.iterator]() {
     return super[Symbol.iterator]();
   }
-  /**
-   * 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(otherData) {
     if (!await this.contains(otherData)) {
       return false;
@@ -154,14 +132,7 @@ var HttpFormData = class extends FormData {
     }
     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(otherData) {
     for (const [otherKey, otherValue] of otherData.entries()) {
       const values = super.getAll.call(this, otherKey);
@@ -182,30 +153,7 @@ var HttpFormData = class extends FormData {
     }
     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 = {};
     for (const [key, value] of this.entries()) {
@@ -247,55 +195,50 @@ var HttpHeaders = class extends Headers {
       super(pickPrimitiveProperties(init));
     }
   }
-  /** @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, value) {
     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, value) {
     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) {
     return super.get(name);
   }
-  /** @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() {
     return super.getSetCookie();
   }
-  /** @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) {
     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) {
     super.delete(name);
   }
+  /** @see {@link https://zimic.dev/docs/http/api/http-headers#headersforEach `headers.forEach()` API reference} */
   forEach(callback, thisArg) {
     super.forEach(callback, 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() {
     return super.keys();
   }
-  /** @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() {
     return super.values();
   }
-  /** @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() {
     return super.entries();
   }
   [Symbol.iterator]() {
     return super[Symbol.iterator]();
   }
-  /**
-   * 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(otherHeaders) {
     if (!this.contains(otherHeaders)) {
       return false;
@@ -308,14 +251,7 @@ var HttpHeaders = class extends Headers {
     }
     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(otherHeaders) {
     for (const [key, otherValue] of otherHeaders.entries()) {
       const value = super.get.call(this, key);
@@ -336,19 +272,7 @@ var HttpHeaders = class extends Headers {
     }
     return true;
   }
-  /**
-   * 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() {
     const object = {};
     for (const [key, value] of this.entries()) {
@@ -398,82 +322,54 @@ var HttpSearchParams = class extends URLSearchParams {
       }
     }
   }
-  /** @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, value) {
     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, value) {
     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) {
     return super.get(name);
   }
-  /**
-   * 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) {
     return super.getAll(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, value) {
     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, value) {
     super.delete(name, value);
   }
+  /** @see {@link https://zimic.dev/docs/http/api/http-search-params#searchparamsforEach `searchParams.forEach()` API reference} */
   forEach(callback, thisArg) {
     super.forEach(callback, 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() {
     return super.keys();
   }
-  /** @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() {
     return super.values();
   }
-  /** @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() {
     return super.entries();
   }
   [Symbol.iterator]() {
     return super[Symbol.iterator]();
   }
-  /**
-   * 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(otherParams) {
     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(otherParams) {
     for (const [key, otherValue] of otherParams.entries()) {
       const values = super.getAll.call(this, key);
@@ -488,24 +384,7 @@ var HttpSearchParams = class extends URLSearchParams {
     }
     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 = {};
     for (const [key, value] of this.entries()) {