@happy-ts/fetch-t 1.0.11 → 1.0.13

package/README.cn.md

@@ -14,6 +14,8 @@ fetchT 的返回值包含一个可以 abort 的方法。
 
 fetchT 的返回数据是一个明确的类型，可以是 `string` `ArrayBuffer` `Blob` `<T>(泛型)`。
 
+支持超时自动取消请求。
+
 ## 安装
 
 pnpm
@@ -63,6 +65,7 @@ import { fetchT } from '@happy-ts/fetch-t';
 const fetchTask = fetchT('https://example.com', {
     abortable: true,
     responseType: 'json',
+    timeout: 3000,
 });
 
 somethingHappenAsync(() => {

package/README.md

@@ -19,6 +19,8 @@ The return value of fetchT includes an `abort` method.
 
 The return data of fetchT is of a specific type, which can be either `string`, `ArrayBuffer`, `Blob`, or `<T>(generic)`.
 
+Support `timeout`.
+
 ## Installation
 
 via pnpm
@@ -74,6 +76,7 @@ import { fetchT } from '@happy-ts/fetch-t';
 const fetchTask = fetchT('https://example.com', {
     abortable: true,
     responseType: 'json',
+    timeout: 3000,
 });
 
 somethingHappenAsync(() => {

package/dist/main.cjs

@@ -3,13 +3,26 @@
 var happyRusty = require('happy-rusty');
 var invariant = require('tiny-invariant');
 
+const ABORT_ERROR = "AbortError";
+const TIMEOUT_ERROR = "TimeoutError";
+
 function fetchT(url, init) {
   if (typeof url !== "string") {
     invariant(url instanceof URL, () => `Url must be a string or URL object but received ${url}.`);
   }
-  const { abortable = false, responseType, ...rest } = init ?? {};
+  const {
+    // default not abort able
+    abortable = false,
+    responseType,
+    timeout,
+    ...rest
+  } = init ?? {};
+  const shouldWaitTimeout = timeout != null;
+  if (shouldWaitTimeout) {
+    invariant(typeof timeout === "number" && timeout > 0, () => `Timeout must be a number greater than 0 but received ${timeout}.`);
+  }
   let controller;
-  if (abortable) {
+  if (abortable || shouldWaitTimeout) {
     controller = new AbortController();
     rest.signal = controller.signal;
   }
@@ -42,6 +55,15 @@ function fetchT(url, init) {
   }).catch((err) => {
     return happyRusty.Err(err);
   });
+  if (shouldWaitTimeout) {
+    setTimeout(() => {
+      if (!controller.signal.aborted) {
+        const error = new Error();
+        error.name = TIMEOUT_ERROR;
+        controller.abort(error);
+      }
+    }, timeout);
+  }
   if (abortable) {
     return {
       abort(reason) {
@@ -57,5 +79,7 @@ function fetchT(url, init) {
   }
 }
 
+exports.ABORT_ERROR = ABORT_ERROR;
+exports.TIMEOUT_ERROR = TIMEOUT_ERROR;
 exports.fetchT = fetchT;
 //# sourceMappingURL=main.cjs.map

package/dist/main.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"main.cjs","sources":["../src/fetch/fetch.ts"],"sourcesContent":["/* eslint-disable @typescript-eslint/no-explicit-any */\nimport { Err, Ok } from 'happy-rusty';\nimport invariant from 'tiny-invariant';\nimport type { FetchInit, FetchResponse, FetchTask } from './defines.ts';\n\n/**\n * Fetches a resource from the network as a text string and returns a `FetchTask` representing the operation.\n *\n * @typeParam T - The expected type of the response data.\n * @param url - The resource to fetch. Can be a URL object or a string representing a URL.\n * @param init - Additional options for the fetch operation, including custom `FetchInit` properties.\n * @returns A `FetchTask` representing the operation with a `string` response.\n */\nexport function fetchT(url: string | URL, init: FetchInit & {\n    abortable: true;\n    responseType: 'text';\n}): FetchTask<string>;\n\n/**\n * Fetches a resource from the network as an ArrayBuffer and returns a `FetchTask` representing the operation.\n *\n * @param url - The resource to fetch. Can be a URL object or a string representing a URL.\n * @param init - Additional options for the fetch operation, including custom `FetchInit` properties.\n * @returns A `FetchTask` representing the operation with an `ArrayBuffer` response.\n */\nexport function fetchT(url: string | URL, init: FetchInit & {\n    abortable: true;\n    responseType: 'arraybuffer';\n}): FetchTask<ArrayBuffer>;\n\n/**\n * Fetches a resource from the network as a Blob and returns a `FetchTask` representing the operation.\n *\n * @param url - The resource to fetch. Can be a URL object or a string representing a URL.\n * @param init - Additional options for the fetch operation, including custom `FetchInit` properties.\n * @returns A `FetchTask` representing the operation with a `Blob` response.\n */\nexport function fetchT(url: string | URL, init: FetchInit & {\n    abortable: true;\n    responseType: 'blob';\n}): FetchTask<Blob>;\n\n/**\n * Fetches a resource from the network and parses it as JSON, returning a `FetchTask` representing the operation.\n *\n * @typeParam T - The expected type of the parsed JSON data.\n * @param url - The resource to fetch. Can be a URL object or a string representing a URL.\n * @param init - Additional options for the fetch operation, including custom `FetchInit` properties.\n * @returns A `FetchTask` representing the operation with a response parsed as JSON.\n */\nexport function fetchT<T>(url: string | URL, init: FetchInit & {\n    abortable: true;\n    responseType: 'json';\n}): FetchTask<T>;\n\n/**\n * Fetches a resource from the network as a text string and returns a `FetchResponse` representing the operation.\n *\n * @param url - The resource to fetch. Can be a URL object or a string representing a URL.\n * @param init - Additional options for the fetch operation, specifying the response type as 'text'.\n * @returns A `FetchResponse` representing the operation with a `string` response.\n */\nexport function fetchT(url: string | URL, init: FetchInit & {\n    responseType: 'text';\n}): FetchResponse<string>;\n\n/**\n * Fetches a resource from the network as an ArrayBuffer and returns a `FetchResponse` representing the operation.\n *\n * @param url - The resource to fetch. Can be a URL object or a string representing a URL.\n * @param init - Additional options for the fetch operation, specifying the response type as 'arraybuffer'.\n * @returns A `FetchResponse` representing the operation with an `ArrayBuffer` response.\n */\nexport function fetchT(url: string | URL, init: FetchInit & {\n    responseType: 'arraybuffer';\n}): FetchResponse<ArrayBuffer>;\n\n/**\n * Fetches a resource from the network as a Blob and returns a `FetchResponse` representing the operation.\n *\n * @param url - The resource to fetch. Can be a URL object or a string representing a URL.\n * @param init - Additional options for the fetch operation, specifying the response type as 'blob'.\n * @returns A `FetchResponse` representing the operation with a `Blob` response.\n */\nexport function fetchT(url: string | URL, init: FetchInit & {\n    responseType: 'blob';\n}): FetchResponse<Blob>;\n\n/**\n * Fetches a resource from the network and parses it as JSON, returning a `FetchResponse` representing the operation.\n *\n * @typeParam T - The expected type of the parsed JSON data.\n * @param url - The resource to fetch. Can be a URL object or a string representing a URL.\n * @param init - Additional options for the fetch operation, specifying the response type as 'json'.\n * @returns A `FetchResponse` representing the operation with a response parsed as JSON.\n */\nexport function fetchT<T>(url: string | URL, init: FetchInit & {\n    responseType: 'json';\n}): FetchResponse<T>;\n\n/**\n * Fetches a resource from the network and returns a `FetchTask` representing the operation with a generic `Response`.\n *\n * @param url - The resource to fetch. Can be a URL object or a string representing a URL.\n * @param init - Additional options for the fetch operation, indicating that the operation should be abortable.\n * @returns A `FetchTask` representing the operation with a generic `Response`.\n */\nexport function fetchT(url: string | URL, init: FetchInit & {\n    abortable: true;\n}): FetchTask<Response>;\n\n/**\n * Fetches a resource from the network and returns a `FetchResponse` representing the operation with a generic `Response`.\n *\n * @param url - The resource to fetch. Can be a URL object or a string representing a URL.\n * @param init - Additional options for the fetch operation, indicating that the operation should not be abortable.\n * @returns A `FetchResponse` representing the operation with a generic `Response`.\n */\nexport function fetchT(url: string | URL, init: FetchInit & {\n    abortable: false;\n}): FetchResponse<Response>;\n\n/**\n * Fetches a resource from the network and returns a `FetchResponse` or `FetchTask` based on the provided options.\n *\n * @typeParam T - The expected type of the response data when not using a specific `responseType`.\n * @param url - The resource to fetch. Can be a URL object or a string representing a URL.\n * @param init - Additional options for the fetch operation, including custom `FetchInit` properties.\n * @returns A `FetchResponse` or `FetchTask` depending on the `abortable` option in `init`.\n */\nexport function fetchT<T>(url: string | URL, init: FetchInit): FetchTask<T> | FetchResponse<T>;\n\n/**\n * Fetches a resource from the network and returns a `FetchResponse` representing the operation.\n *\n * @param url - The resource to fetch. Can be a URL object or a string representing a URL.\n * @param init - Standard `RequestInit` options for the fetch operation.\n * @returns A `FetchResponse` representing the operation with a `Response` object.\n */\nexport function fetchT(url: string | URL, init?: RequestInit): FetchResponse<Response>;\n\n/**\n * Fetches a resource from the network and returns either a `FetchTask` or `FetchResponse` based on the provided options.\n *\n * @typeParam T - The expected type of the response data when not using a specific `responseType`.\n * @param url - The resource to fetch. Can be a URL object or a string representing a URL.\n * @param init - Additional options for the fetch operation, including custom `FetchInit` properties.\n * @returns A `FetchTask` or `FetchResponse` depending on the provided options in `init`.\n */\nexport function fetchT<T>(url: string | URL, init?: FetchInit): FetchTask<T> | FetchResponse<T> {\n    // most cases\n    if (typeof url !== 'string') {\n        invariant(url instanceof URL, () => `Url must be a string or URL object but received ${ url }.`);\n    }\n\n    // default not abort able\n    const { abortable = false, responseType, ...rest } = init ?? {};\n\n    let controller: AbortController;\n\n    if (abortable) {\n        controller = new AbortController();\n        rest.signal = controller.signal;\n    }\n\n    const response: FetchResponse<T> = fetch(url, rest).then(async (res): FetchResponse<T> => {\n        if (!res.ok) {\n            await res.body?.cancel();\n            return Err(new Error(`fetch status: ${ res.status }`));\n        }\n\n        switch (responseType) {\n            case 'arraybuffer': {\n                return Ok(await res.arrayBuffer() as T);\n            }\n            case 'blob': {\n                return Ok(await res.blob() as T);\n            }\n            case 'json': {\n                try {\n                    return Ok(await res.json() as T);\n                } catch {\n                    return Err(new Error('Response is invalid json while responseType is json'));\n                }\n            }\n            case 'text': {\n                return Ok(await res.text() as T);\n            }\n            default: {\n                // default return the Response object\n                return Ok(res as T);\n            }\n        }\n    }).catch((err) => {\n        return Err(err);\n    });\n\n    if (abortable) {\n        return {\n            abort(reason?: any): void {\n                controller.abort(reason);\n            },\n            get aborted(): boolean {\n                return controller.signal.aborted;\n            },\n            response,\n        };\n    } else {\n        return response;\n    }\n}"],"names":["Err","Ok"],"mappings":";;;;;AAqJgB,SAAA,MAAA,CAAU,KAAmB,IAAmD,EAAA;AAE5F,EAAI,IAAA,OAAO,QAAQ,QAAU,EAAA;AACzB,IAAA,SAAA,CAAU,GAAe,YAAA,GAAA,EAAK,MAAM,CAAA,gDAAA,EAAoD,GAAI,CAAG,CAAA,CAAA,CAAA,CAAA;AAAA,GACnG;AAGA,EAAM,MAAA,EAAE,YAAY,KAAO,EAAA,YAAA,EAAc,GAAG,IAAK,EAAA,GAAI,QAAQ,EAAC,CAAA;AAE9D,EAAI,IAAA,UAAA,CAAA;AAEJ,EAAA,IAAI,SAAW,EAAA;AACX,IAAA,UAAA,GAAa,IAAI,eAAgB,EAAA,CAAA;AACjC,IAAA,IAAA,CAAK,SAAS,UAAW,CAAA,MAAA,CAAA;AAAA,GAC7B;AAEA,EAAA,MAAM,WAA6B,KAAM,CAAA,GAAA,EAAK,IAAI,CAAE,CAAA,IAAA,CAAK,OAAO,GAA0B,KAAA;AACtF,IAAI,IAAA,CAAC,IAAI,EAAI,EAAA;AACT,MAAM,MAAA,GAAA,CAAI,MAAM,MAAO,EAAA,CAAA;AACvB,MAAA,OAAOA,eAAI,IAAI,KAAA,CAAM,iBAAkB,GAAI,CAAA,MAAO,EAAE,CAAC,CAAA,CAAA;AAAA,KACzD;AAEA,IAAA,QAAQ,YAAc;AAAA,MAClB,KAAK,aAAe,EAAA;AAChB,QAAA,OAAOC,aAAG,CAAA,MAAM,GAAI,CAAA,WAAA,EAAkB,CAAA,CAAA;AAAA,OAC1C;AAAA,MACA,KAAK,MAAQ,EAAA;AACT,QAAA,OAAOA,aAAG,CAAA,MAAM,GAAI,CAAA,IAAA,EAAW,CAAA,CAAA;AAAA,OACnC;AAAA,MACA,KAAK,MAAQ,EAAA;AACT,QAAI,IAAA;AACA,UAAA,OAAOA,aAAG,CAAA,MAAM,GAAI,CAAA,IAAA,EAAW,CAAA,CAAA;AAAA,SAC3B,CAAA,MAAA;AACJ,UAAA,OAAOD,cAAI,CAAA,IAAI,KAAM,CAAA,qDAAqD,CAAC,CAAA,CAAA;AAAA,SAC/E;AAAA,OACJ;AAAA,MACA,KAAK,MAAQ,EAAA;AACT,QAAA,OAAOC,aAAG,CAAA,MAAM,GAAI,CAAA,IAAA,EAAW,CAAA,CAAA;AAAA,OACnC;AAAA,MACA,SAAS;AAEL,QAAA,OAAOA,cAAG,GAAQ,CAAA,CAAA;AAAA,OACtB;AAAA,KACJ;AAAA,GACH,CAAA,CAAE,KAAM,CAAA,CAAC,GAAQ,KAAA;AACd,IAAA,OAAOD,eAAI,GAAG,CAAA,CAAA;AAAA,GACjB,CAAA,CAAA;AAED,EAAA,IAAI,SAAW,EAAA;AACX,IAAO,OAAA;AAAA,MACH,MAAM,MAAoB,EAAA;AACtB,QAAA,UAAA,CAAW,MAAM,MAAM,CAAA,CAAA;AAAA,OAC3B;AAAA,MACA,IAAI,OAAmB,GAAA;AACnB,QAAA,OAAO,WAAW,MAAO,CAAA,OAAA,CAAA;AAAA,OAC7B;AAAA,MACA,QAAA;AAAA,KACJ,CAAA;AAAA,GACG,MAAA;AACH,IAAO,OAAA,QAAA,CAAA;AAAA,GACX;AACJ;;;;"}
+{"version":3,"file":"main.cjs","sources":["../src/fetch/defines.ts","../src/fetch/fetch.ts"],"sourcesContent":["/* eslint-disable @typescript-eslint/no-explicit-any */\nimport type { AsyncResult } from 'happy-rusty';\n\n/**\n * Represents the response of a fetch operation, encapsulating the result data or any error that occurred.\n *\n * @typeParam T - The type of the data expected in the response.\n */\nexport type FetchResponse<T> = AsyncResult<T, any>;\n\n/**\n * Defines the structure and behavior of a fetch task, including the ability to abort the task and check its status.\n *\n * @typeParam T - The type of the data expected in the response.\n */\nexport interface FetchTask<T> {\n    /**\n     * Aborts the fetch task, optionally with a reason for the abortion.\n     *\n     * @param reason - An optional parameter to indicate why the task was aborted.\n     */\n    abort(reason?: any): void;\n\n    /**\n     * Indicates whether the fetch task has been aborted.\n     */\n    aborted: boolean;\n\n    /**\n     * The response of the fetch task, represented as an `AsyncResult`.\n     */\n    response: FetchResponse<T>;\n}\n\n/**\n * Extends the standard `RequestInit` interface from the Fetch API to include additional custom options.\n */\nexport interface FetchInit extends RequestInit {\n    /**\n     * Indicates whether the fetch request should be abortable.\n     */\n    abortable?: boolean;\n\n    /**\n     * Specifies the expected response type of the fetch request.\n     */\n    responseType?: 'text' | 'arraybuffer' | 'blob' | 'json';\n\n    /**\n     * Specifies the maximum time in milliseconds to wait for the fetch request to complete.\n     */\n    timeout?: number;\n}\n\n/**\n * Name of abort error;\n */\nexport const ABORT_ERROR = 'AbortError';\n\n/**\n * Name of timeout error;\n */\nexport const TIMEOUT_ERROR = 'TimeoutError';","/* eslint-disable @typescript-eslint/no-explicit-any */\nimport { Err, Ok } from 'happy-rusty';\nimport invariant from 'tiny-invariant';\nimport { TIMEOUT_ERROR, type FetchInit, type FetchResponse, type FetchTask } from './defines.ts';\n\n/**\n * Fetches a resource from the network as a text string and returns a `FetchTask` representing the operation.\n *\n * @typeParam T - The expected type of the response data.\n * @param url - The resource to fetch. Can be a URL object or a string representing a URL.\n * @param init - Additional options for the fetch operation, including custom `FetchInit` properties.\n * @returns A `FetchTask` representing the operation with a `string` response.\n */\nexport function fetchT(url: string | URL, init: FetchInit & {\n    abortable: true;\n    responseType: 'text';\n}): FetchTask<string>;\n\n/**\n * Fetches a resource from the network as an ArrayBuffer and returns a `FetchTask` representing the operation.\n *\n * @param url - The resource to fetch. Can be a URL object or a string representing a URL.\n * @param init - Additional options for the fetch operation, including custom `FetchInit` properties.\n * @returns A `FetchTask` representing the operation with an `ArrayBuffer` response.\n */\nexport function fetchT(url: string | URL, init: FetchInit & {\n    abortable: true;\n    responseType: 'arraybuffer';\n}): FetchTask<ArrayBuffer>;\n\n/**\n * Fetches a resource from the network as a Blob and returns a `FetchTask` representing the operation.\n *\n * @param url - The resource to fetch. Can be a URL object or a string representing a URL.\n * @param init - Additional options for the fetch operation, including custom `FetchInit` properties.\n * @returns A `FetchTask` representing the operation with a `Blob` response.\n */\nexport function fetchT(url: string | URL, init: FetchInit & {\n    abortable: true;\n    responseType: 'blob';\n}): FetchTask<Blob>;\n\n/**\n * Fetches a resource from the network and parses it as JSON, returning a `FetchTask` representing the operation.\n *\n * @typeParam T - The expected type of the parsed JSON data.\n * @param url - The resource to fetch. Can be a URL object or a string representing a URL.\n * @param init - Additional options for the fetch operation, including custom `FetchInit` properties.\n * @returns A `FetchTask` representing the operation with a response parsed as JSON.\n */\nexport function fetchT<T>(url: string | URL, init: FetchInit & {\n    abortable: true;\n    responseType: 'json';\n}): FetchTask<T>;\n\n/**\n * Fetches a resource from the network as a text string and returns a `FetchResponse` representing the operation.\n *\n * @param url - The resource to fetch. Can be a URL object or a string representing a URL.\n * @param init - Additional options for the fetch operation, specifying the response type as 'text'.\n * @returns A `FetchResponse` representing the operation with a `string` response.\n */\nexport function fetchT(url: string | URL, init: FetchInit & {\n    responseType: 'text';\n}): FetchResponse<string>;\n\n/**\n * Fetches a resource from the network as an ArrayBuffer and returns a `FetchResponse` representing the operation.\n *\n * @param url - The resource to fetch. Can be a URL object or a string representing a URL.\n * @param init - Additional options for the fetch operation, specifying the response type as 'arraybuffer'.\n * @returns A `FetchResponse` representing the operation with an `ArrayBuffer` response.\n */\nexport function fetchT(url: string | URL, init: FetchInit & {\n    responseType: 'arraybuffer';\n}): FetchResponse<ArrayBuffer>;\n\n/**\n * Fetches a resource from the network as a Blob and returns a `FetchResponse` representing the operation.\n *\n * @param url - The resource to fetch. Can be a URL object or a string representing a URL.\n * @param init - Additional options for the fetch operation, specifying the response type as 'blob'.\n * @returns A `FetchResponse` representing the operation with a `Blob` response.\n */\nexport function fetchT(url: string | URL, init: FetchInit & {\n    responseType: 'blob';\n}): FetchResponse<Blob>;\n\n/**\n * Fetches a resource from the network and parses it as JSON, returning a `FetchResponse` representing the operation.\n *\n * @typeParam T - The expected type of the parsed JSON data.\n * @param url - The resource to fetch. Can be a URL object or a string representing a URL.\n * @param init - Additional options for the fetch operation, specifying the response type as 'json'.\n * @returns A `FetchResponse` representing the operation with a response parsed as JSON.\n */\nexport function fetchT<T>(url: string | URL, init: FetchInit & {\n    responseType: 'json';\n}): FetchResponse<T>;\n\n/**\n * Fetches a resource from the network and returns a `FetchTask` representing the operation with a generic `Response`.\n *\n * @param url - The resource to fetch. Can be a URL object or a string representing a URL.\n * @param init - Additional options for the fetch operation, indicating that the operation should be abortable.\n * @returns A `FetchTask` representing the operation with a generic `Response`.\n */\nexport function fetchT(url: string | URL, init: FetchInit & {\n    abortable: true;\n}): FetchTask<Response>;\n\n/**\n * Fetches a resource from the network and returns a `FetchResponse` representing the operation with a generic `Response`.\n *\n * @param url - The resource to fetch. Can be a URL object or a string representing a URL.\n * @param init - Additional options for the fetch operation, indicating that the operation should not be abortable.\n * @returns A `FetchResponse` representing the operation with a generic `Response`.\n */\nexport function fetchT(url: string | URL, init: FetchInit & {\n    abortable: false;\n}): FetchResponse<Response>;\n\n/**\n * Fetches a resource from the network and returns a `FetchResponse` representing the operation with a generic `Response`.\n *\n * @param url - The resource to fetch. Can be a URL object or a string representing a URL.\n * @param init - Additional options for the fetch operation, indicating that the operation should not be abortable.\n * @returns A `FetchResponse` representing the operation with a generic `Response`.\n */\nexport function fetchT(url: string | URL, init: FetchInit & {\n    timeout: number;\n}): FetchResponse<Response>;\n\n/**\n * Fetches a resource from the network and returns a `FetchResponse` or `FetchTask` based on the provided options.\n *\n * @typeParam T - The expected type of the response data when not using a specific `responseType`.\n * @param url - The resource to fetch. Can be a URL object or a string representing a URL.\n * @param init - Additional options for the fetch operation, including custom `FetchInit` properties.\n * @returns A `FetchResponse` or `FetchTask` depending on the `abortable` option in `init`.\n */\nexport function fetchT<T>(url: string | URL, init: FetchInit): FetchTask<T> | FetchResponse<T>;\n\n/**\n * Fetches a resource from the network and returns a `FetchResponse` representing the operation.\n *\n * @param url - The resource to fetch. Can be a URL object or a string representing a URL.\n * @param init - Standard `RequestInit` options for the fetch operation.\n * @returns A `FetchResponse` representing the operation with a `Response` object.\n */\nexport function fetchT(url: string | URL, init?: RequestInit): FetchResponse<Response>;\n\n/**\n * Fetches a resource from the network and returns either a `FetchTask` or `FetchResponse` based on the provided options.\n *\n * @typeParam T - The expected type of the response data when not using a specific `responseType`.\n * @param url - The resource to fetch. Can be a URL object or a string representing a URL.\n * @param init - Additional options for the fetch operation, including custom `FetchInit` properties.\n * @returns A `FetchTask` or `FetchResponse` depending on the provided options in `init`.\n */\nexport function fetchT<T>(url: string | URL, init?: FetchInit): FetchTask<T> | FetchResponse<T> {\n    // most cases\n    if (typeof url !== 'string') {\n        invariant(url instanceof URL, () => `Url must be a string or URL object but received ${ url }.`);\n    }\n\n    const {\n        // default not abort able\n        abortable = false,\n        responseType,\n        timeout,\n        ...rest\n    } = init ?? {};\n\n    const shouldWaitTimeout = timeout != null;\n\n    if (shouldWaitTimeout) {\n        invariant(typeof timeout === 'number' && timeout > 0, () => `Timeout must be a number greater than 0 but received ${ timeout }.`);\n    }\n\n    let controller: AbortController;\n\n    if (abortable || shouldWaitTimeout) {\n        controller = new AbortController();\n        rest.signal = controller.signal;\n    }\n\n    const response: FetchResponse<T> = fetch(url, rest).then(async (res): FetchResponse<T> => {\n        if (!res.ok) {\n            await res.body?.cancel();\n            return Err(new Error(`fetch status: ${ res.status }`));\n        }\n\n        switch (responseType) {\n            case 'arraybuffer': {\n                return Ok(await res.arrayBuffer() as T);\n            }\n            case 'blob': {\n                return Ok(await res.blob() as T);\n            }\n            case 'json': {\n                try {\n                    return Ok(await res.json() as T);\n                } catch {\n                    return Err(new Error('Response is invalid json while responseType is json'));\n                }\n            }\n            case 'text': {\n                return Ok(await res.text() as T);\n            }\n            default: {\n                // default return the Response object\n                return Ok(res as T);\n            }\n        }\n    }).catch((err) => {\n        return Err(err);\n    });\n\n    if (shouldWaitTimeout) {\n        setTimeout(() => {\n            if (!controller.signal.aborted) {\n                const error = new Error();\n                error.name = TIMEOUT_ERROR;\n                controller.abort(error);\n            }\n        }, timeout);\n    }\n\n    if (abortable) {\n        return {\n            abort(reason?: any): void {\n                controller.abort(reason);\n            },\n            get aborted(): boolean {\n                return controller.signal.aborted;\n            },\n            response,\n        };\n    } else {\n        return response;\n    }\n}"],"names":["Err","Ok"],"mappings":";;;;;AAyDO,MAAM,WAAc,GAAA,aAAA;AAKpB,MAAM,aAAgB,GAAA;;ACkGb,SAAA,MAAA,CAAU,KAAmB,IAAmD,EAAA;AAE5F,EAAI,IAAA,OAAO,QAAQ,QAAU,EAAA;AACzB,IAAA,SAAA,CAAU,GAAe,YAAA,GAAA,EAAK,MAAM,CAAA,gDAAA,EAAoD,GAAI,CAAG,CAAA,CAAA,CAAA,CAAA;AAAA,GACnG;AAEA,EAAM,MAAA;AAAA;AAAA,IAEF,SAAY,GAAA,KAAA;AAAA,IACZ,YAAA;AAAA,IACA,OAAA;AAAA,IACA,GAAG,IAAA;AAAA,GACP,GAAI,QAAQ,EAAC,CAAA;AAEb,EAAA,MAAM,oBAAoB,OAAW,IAAA,IAAA,CAAA;AAErC,EAAA,IAAI,iBAAmB,EAAA;AACnB,IAAU,SAAA,CAAA,OAAO,YAAY,QAAY,IAAA,OAAA,GAAU,GAAG,MAAM,CAAA,qDAAA,EAAyD,OAAQ,CAAG,CAAA,CAAA,CAAA,CAAA;AAAA,GACpI;AAEA,EAAI,IAAA,UAAA,CAAA;AAEJ,EAAA,IAAI,aAAa,iBAAmB,EAAA;AAChC,IAAA,UAAA,GAAa,IAAI,eAAgB,EAAA,CAAA;AACjC,IAAA,IAAA,CAAK,SAAS,UAAW,CAAA,MAAA,CAAA;AAAA,GAC7B;AAEA,EAAA,MAAM,WAA6B,KAAM,CAAA,GAAA,EAAK,IAAI,CAAE,CAAA,IAAA,CAAK,OAAO,GAA0B,KAAA;AACtF,IAAI,IAAA,CAAC,IAAI,EAAI,EAAA;AACT,MAAM,MAAA,GAAA,CAAI,MAAM,MAAO,EAAA,CAAA;AACvB,MAAA,OAAOA,eAAI,IAAI,KAAA,CAAM,iBAAkB,GAAI,CAAA,MAAO,EAAE,CAAC,CAAA,CAAA;AAAA,KACzD;AAEA,IAAA,QAAQ,YAAc;AAAA,MAClB,KAAK,aAAe,EAAA;AAChB,QAAA,OAAOC,aAAG,CAAA,MAAM,GAAI,CAAA,WAAA,EAAkB,CAAA,CAAA;AAAA,OAC1C;AAAA,MACA,KAAK,MAAQ,EAAA;AACT,QAAA,OAAOA,aAAG,CAAA,MAAM,GAAI,CAAA,IAAA,EAAW,CAAA,CAAA;AAAA,OACnC;AAAA,MACA,KAAK,MAAQ,EAAA;AACT,QAAI,IAAA;AACA,UAAA,OAAOA,aAAG,CAAA,MAAM,GAAI,CAAA,IAAA,EAAW,CAAA,CAAA;AAAA,SAC3B,CAAA,MAAA;AACJ,UAAA,OAAOD,cAAI,CAAA,IAAI,KAAM,CAAA,qDAAqD,CAAC,CAAA,CAAA;AAAA,SAC/E;AAAA,OACJ;AAAA,MACA,KAAK,MAAQ,EAAA;AACT,QAAA,OAAOC,aAAG,CAAA,MAAM,GAAI,CAAA,IAAA,EAAW,CAAA,CAAA;AAAA,OACnC;AAAA,MACA,SAAS;AAEL,QAAA,OAAOA,cAAG,GAAQ,CAAA,CAAA;AAAA,OACtB;AAAA,KACJ;AAAA,GACH,CAAA,CAAE,KAAM,CAAA,CAAC,GAAQ,KAAA;AACd,IAAA,OAAOD,eAAI,GAAG,CAAA,CAAA;AAAA,GACjB,CAAA,CAAA;AAED,EAAA,IAAI,iBAAmB,EAAA;AACnB,IAAA,UAAA,CAAW,MAAM;AACb,MAAI,IAAA,CAAC,UAAW,CAAA,MAAA,CAAO,OAAS,EAAA;AAC5B,QAAM,MAAA,KAAA,GAAQ,IAAI,KAAM,EAAA,CAAA;AACxB,QAAA,KAAA,CAAM,IAAO,GAAA,aAAA,CAAA;AACb,QAAA,UAAA,CAAW,MAAM,KAAK,CAAA,CAAA;AAAA,OAC1B;AAAA,OACD,OAAO,CAAA,CAAA;AAAA,GACd;AAEA,EAAA,IAAI,SAAW,EAAA;AACX,IAAO,OAAA;AAAA,MACH,MAAM,MAAoB,EAAA;AACtB,QAAA,UAAA,CAAW,MAAM,MAAM,CAAA,CAAA;AAAA,OAC3B;AAAA,MACA,IAAI,OAAmB,GAAA;AACnB,QAAA,OAAO,WAAW,MAAO,CAAA,OAAA,CAAA;AAAA,OAC7B;AAAA,MACA,QAAA;AAAA,KACJ,CAAA;AAAA,GACG,MAAA;AACH,IAAO,OAAA,QAAA,CAAA;AAAA,GACX;AACJ;;;;;;"}

package/dist/main.mjs

@@ -1,13 +1,26 @@
 import { Err, Ok } from 'happy-rusty';
 import invariant from 'tiny-invariant';
 
+const ABORT_ERROR = "AbortError";
+const TIMEOUT_ERROR = "TimeoutError";
+
 function fetchT(url, init) {
   if (typeof url !== "string") {
     invariant(url instanceof URL, () => `Url must be a string or URL object but received ${url}.`);
   }
-  const { abortable = false, responseType, ...rest } = init ?? {};
+  const {
+    // default not abort able
+    abortable = false,
+    responseType,
+    timeout,
+    ...rest
+  } = init ?? {};
+  const shouldWaitTimeout = timeout != null;
+  if (shouldWaitTimeout) {
+    invariant(typeof timeout === "number" && timeout > 0, () => `Timeout must be a number greater than 0 but received ${timeout}.`);
+  }
   let controller;
-  if (abortable) {
+  if (abortable || shouldWaitTimeout) {
     controller = new AbortController();
     rest.signal = controller.signal;
   }
@@ -40,6 +53,15 @@ function fetchT(url, init) {
   }).catch((err) => {
     return Err(err);
   });
+  if (shouldWaitTimeout) {
+    setTimeout(() => {
+      if (!controller.signal.aborted) {
+        const error = new Error();
+        error.name = TIMEOUT_ERROR;
+        controller.abort(error);
+      }
+    }, timeout);
+  }
   if (abortable) {
     return {
       abort(reason) {
@@ -55,5 +77,5 @@ function fetchT(url, init) {
   }
 }
 
-export { fetchT };
+export { ABORT_ERROR, TIMEOUT_ERROR, fetchT };
 //# sourceMappingURL=main.mjs.map

package/dist/main.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"main.mjs","sources":["../src/fetch/fetch.ts"],"sourcesContent":["/* eslint-disable @typescript-eslint/no-explicit-any */\nimport { Err, Ok } from 'happy-rusty';\nimport invariant from 'tiny-invariant';\nimport type { FetchInit, FetchResponse, FetchTask } from './defines.ts';\n\n/**\n * Fetches a resource from the network as a text string and returns a `FetchTask` representing the operation.\n *\n * @typeParam T - The expected type of the response data.\n * @param url - The resource to fetch. Can be a URL object or a string representing a URL.\n * @param init - Additional options for the fetch operation, including custom `FetchInit` properties.\n * @returns A `FetchTask` representing the operation with a `string` response.\n */\nexport function fetchT(url: string | URL, init: FetchInit & {\n    abortable: true;\n    responseType: 'text';\n}): FetchTask<string>;\n\n/**\n * Fetches a resource from the network as an ArrayBuffer and returns a `FetchTask` representing the operation.\n *\n * @param url - The resource to fetch. Can be a URL object or a string representing a URL.\n * @param init - Additional options for the fetch operation, including custom `FetchInit` properties.\n * @returns A `FetchTask` representing the operation with an `ArrayBuffer` response.\n */\nexport function fetchT(url: string | URL, init: FetchInit & {\n    abortable: true;\n    responseType: 'arraybuffer';\n}): FetchTask<ArrayBuffer>;\n\n/**\n * Fetches a resource from the network as a Blob and returns a `FetchTask` representing the operation.\n *\n * @param url - The resource to fetch. Can be a URL object or a string representing a URL.\n * @param init - Additional options for the fetch operation, including custom `FetchInit` properties.\n * @returns A `FetchTask` representing the operation with a `Blob` response.\n */\nexport function fetchT(url: string | URL, init: FetchInit & {\n    abortable: true;\n    responseType: 'blob';\n}): FetchTask<Blob>;\n\n/**\n * Fetches a resource from the network and parses it as JSON, returning a `FetchTask` representing the operation.\n *\n * @typeParam T - The expected type of the parsed JSON data.\n * @param url - The resource to fetch. Can be a URL object or a string representing a URL.\n * @param init - Additional options for the fetch operation, including custom `FetchInit` properties.\n * @returns A `FetchTask` representing the operation with a response parsed as JSON.\n */\nexport function fetchT<T>(url: string | URL, init: FetchInit & {\n    abortable: true;\n    responseType: 'json';\n}): FetchTask<T>;\n\n/**\n * Fetches a resource from the network as a text string and returns a `FetchResponse` representing the operation.\n *\n * @param url - The resource to fetch. Can be a URL object or a string representing a URL.\n * @param init - Additional options for the fetch operation, specifying the response type as 'text'.\n * @returns A `FetchResponse` representing the operation with a `string` response.\n */\nexport function fetchT(url: string | URL, init: FetchInit & {\n    responseType: 'text';\n}): FetchResponse<string>;\n\n/**\n * Fetches a resource from the network as an ArrayBuffer and returns a `FetchResponse` representing the operation.\n *\n * @param url - The resource to fetch. Can be a URL object or a string representing a URL.\n * @param init - Additional options for the fetch operation, specifying the response type as 'arraybuffer'.\n * @returns A `FetchResponse` representing the operation with an `ArrayBuffer` response.\n */\nexport function fetchT(url: string | URL, init: FetchInit & {\n    responseType: 'arraybuffer';\n}): FetchResponse<ArrayBuffer>;\n\n/**\n * Fetches a resource from the network as a Blob and returns a `FetchResponse` representing the operation.\n *\n * @param url - The resource to fetch. Can be a URL object or a string representing a URL.\n * @param init - Additional options for the fetch operation, specifying the response type as 'blob'.\n * @returns A `FetchResponse` representing the operation with a `Blob` response.\n */\nexport function fetchT(url: string | URL, init: FetchInit & {\n    responseType: 'blob';\n}): FetchResponse<Blob>;\n\n/**\n * Fetches a resource from the network and parses it as JSON, returning a `FetchResponse` representing the operation.\n *\n * @typeParam T - The expected type of the parsed JSON data.\n * @param url - The resource to fetch. Can be a URL object or a string representing a URL.\n * @param init - Additional options for the fetch operation, specifying the response type as 'json'.\n * @returns A `FetchResponse` representing the operation with a response parsed as JSON.\n */\nexport function fetchT<T>(url: string | URL, init: FetchInit & {\n    responseType: 'json';\n}): FetchResponse<T>;\n\n/**\n * Fetches a resource from the network and returns a `FetchTask` representing the operation with a generic `Response`.\n *\n * @param url - The resource to fetch. Can be a URL object or a string representing a URL.\n * @param init - Additional options for the fetch operation, indicating that the operation should be abortable.\n * @returns A `FetchTask` representing the operation with a generic `Response`.\n */\nexport function fetchT(url: string | URL, init: FetchInit & {\n    abortable: true;\n}): FetchTask<Response>;\n\n/**\n * Fetches a resource from the network and returns a `FetchResponse` representing the operation with a generic `Response`.\n *\n * @param url - The resource to fetch. Can be a URL object or a string representing a URL.\n * @param init - Additional options for the fetch operation, indicating that the operation should not be abortable.\n * @returns A `FetchResponse` representing the operation with a generic `Response`.\n */\nexport function fetchT(url: string | URL, init: FetchInit & {\n    abortable: false;\n}): FetchResponse<Response>;\n\n/**\n * Fetches a resource from the network and returns a `FetchResponse` or `FetchTask` based on the provided options.\n *\n * @typeParam T - The expected type of the response data when not using a specific `responseType`.\n * @param url - The resource to fetch. Can be a URL object or a string representing a URL.\n * @param init - Additional options for the fetch operation, including custom `FetchInit` properties.\n * @returns A `FetchResponse` or `FetchTask` depending on the `abortable` option in `init`.\n */\nexport function fetchT<T>(url: string | URL, init: FetchInit): FetchTask<T> | FetchResponse<T>;\n\n/**\n * Fetches a resource from the network and returns a `FetchResponse` representing the operation.\n *\n * @param url - The resource to fetch. Can be a URL object or a string representing a URL.\n * @param init - Standard `RequestInit` options for the fetch operation.\n * @returns A `FetchResponse` representing the operation with a `Response` object.\n */\nexport function fetchT(url: string | URL, init?: RequestInit): FetchResponse<Response>;\n\n/**\n * Fetches a resource from the network and returns either a `FetchTask` or `FetchResponse` based on the provided options.\n *\n * @typeParam T - The expected type of the response data when not using a specific `responseType`.\n * @param url - The resource to fetch. Can be a URL object or a string representing a URL.\n * @param init - Additional options for the fetch operation, including custom `FetchInit` properties.\n * @returns A `FetchTask` or `FetchResponse` depending on the provided options in `init`.\n */\nexport function fetchT<T>(url: string | URL, init?: FetchInit): FetchTask<T> | FetchResponse<T> {\n    // most cases\n    if (typeof url !== 'string') {\n        invariant(url instanceof URL, () => `Url must be a string or URL object but received ${ url }.`);\n    }\n\n    // default not abort able\n    const { abortable = false, responseType, ...rest } = init ?? {};\n\n    let controller: AbortController;\n\n    if (abortable) {\n        controller = new AbortController();\n        rest.signal = controller.signal;\n    }\n\n    const response: FetchResponse<T> = fetch(url, rest).then(async (res): FetchResponse<T> => {\n        if (!res.ok) {\n            await res.body?.cancel();\n            return Err(new Error(`fetch status: ${ res.status }`));\n        }\n\n        switch (responseType) {\n            case 'arraybuffer': {\n                return Ok(await res.arrayBuffer() as T);\n            }\n            case 'blob': {\n                return Ok(await res.blob() as T);\n            }\n            case 'json': {\n                try {\n                    return Ok(await res.json() as T);\n                } catch {\n                    return Err(new Error('Response is invalid json while responseType is json'));\n                }\n            }\n            case 'text': {\n                return Ok(await res.text() as T);\n            }\n            default: {\n                // default return the Response object\n                return Ok(res as T);\n            }\n        }\n    }).catch((err) => {\n        return Err(err);\n    });\n\n    if (abortable) {\n        return {\n            abort(reason?: any): void {\n                controller.abort(reason);\n            },\n            get aborted(): boolean {\n                return controller.signal.aborted;\n            },\n            response,\n        };\n    } else {\n        return response;\n    }\n}"],"names":[],"mappings":";;;AAqJgB,SAAA,MAAA,CAAU,KAAmB,IAAmD,EAAA;AAE5F,EAAI,IAAA,OAAO,QAAQ,QAAU,EAAA;AACzB,IAAA,SAAA,CAAU,GAAe,YAAA,GAAA,EAAK,MAAM,CAAA,gDAAA,EAAoD,GAAI,CAAG,CAAA,CAAA,CAAA,CAAA;AAAA,GACnG;AAGA,EAAM,MAAA,EAAE,YAAY,KAAO,EAAA,YAAA,EAAc,GAAG,IAAK,EAAA,GAAI,QAAQ,EAAC,CAAA;AAE9D,EAAI,IAAA,UAAA,CAAA;AAEJ,EAAA,IAAI,SAAW,EAAA;AACX,IAAA,UAAA,GAAa,IAAI,eAAgB,EAAA,CAAA;AACjC,IAAA,IAAA,CAAK,SAAS,UAAW,CAAA,MAAA,CAAA;AAAA,GAC7B;AAEA,EAAA,MAAM,WAA6B,KAAM,CAAA,GAAA,EAAK,IAAI,CAAE,CAAA,IAAA,CAAK,OAAO,GAA0B,KAAA;AACtF,IAAI,IAAA,CAAC,IAAI,EAAI,EAAA;AACT,MAAM,MAAA,GAAA,CAAI,MAAM,MAAO,EAAA,CAAA;AACvB,MAAA,OAAO,IAAI,IAAI,KAAA,CAAM,iBAAkB,GAAI,CAAA,MAAO,EAAE,CAAC,CAAA,CAAA;AAAA,KACzD;AAEA,IAAA,QAAQ,YAAc;AAAA,MAClB,KAAK,aAAe,EAAA;AAChB,QAAA,OAAO,EAAG,CAAA,MAAM,GAAI,CAAA,WAAA,EAAkB,CAAA,CAAA;AAAA,OAC1C;AAAA,MACA,KAAK,MAAQ,EAAA;AACT,QAAA,OAAO,EAAG,CAAA,MAAM,GAAI,CAAA,IAAA,EAAW,CAAA,CAAA;AAAA,OACnC;AAAA,MACA,KAAK,MAAQ,EAAA;AACT,QAAI,IAAA;AACA,UAAA,OAAO,EAAG,CAAA,MAAM,GAAI,CAAA,IAAA,EAAW,CAAA,CAAA;AAAA,SAC3B,CAAA,MAAA;AACJ,UAAA,OAAO,GAAI,CAAA,IAAI,KAAM,CAAA,qDAAqD,CAAC,CAAA,CAAA;AAAA,SAC/E;AAAA,OACJ;AAAA,MACA,KAAK,MAAQ,EAAA;AACT,QAAA,OAAO,EAAG,CAAA,MAAM,GAAI,CAAA,IAAA,EAAW,CAAA,CAAA;AAAA,OACnC;AAAA,MACA,SAAS;AAEL,QAAA,OAAO,GAAG,GAAQ,CAAA,CAAA;AAAA,OACtB;AAAA,KACJ;AAAA,GACH,CAAA,CAAE,KAAM,CAAA,CAAC,GAAQ,KAAA;AACd,IAAA,OAAO,IAAI,GAAG,CAAA,CAAA;AAAA,GACjB,CAAA,CAAA;AAED,EAAA,IAAI,SAAW,EAAA;AACX,IAAO,OAAA;AAAA,MACH,MAAM,MAAoB,EAAA;AACtB,QAAA,UAAA,CAAW,MAAM,MAAM,CAAA,CAAA;AAAA,OAC3B;AAAA,MACA,IAAI,OAAmB,GAAA;AACnB,QAAA,OAAO,WAAW,MAAO,CAAA,OAAA,CAAA;AAAA,OAC7B;AAAA,MACA,QAAA;AAAA,KACJ,CAAA;AAAA,GACG,MAAA;AACH,IAAO,OAAA,QAAA,CAAA;AAAA,GACX;AACJ;;;;"}
+{"version":3,"file":"main.mjs","sources":["../src/fetch/defines.ts","../src/fetch/fetch.ts"],"sourcesContent":["/* eslint-disable @typescript-eslint/no-explicit-any */\nimport type { AsyncResult } from 'happy-rusty';\n\n/**\n * Represents the response of a fetch operation, encapsulating the result data or any error that occurred.\n *\n * @typeParam T - The type of the data expected in the response.\n */\nexport type FetchResponse<T> = AsyncResult<T, any>;\n\n/**\n * Defines the structure and behavior of a fetch task, including the ability to abort the task and check its status.\n *\n * @typeParam T - The type of the data expected in the response.\n */\nexport interface FetchTask<T> {\n    /**\n     * Aborts the fetch task, optionally with a reason for the abortion.\n     *\n     * @param reason - An optional parameter to indicate why the task was aborted.\n     */\n    abort(reason?: any): void;\n\n    /**\n     * Indicates whether the fetch task has been aborted.\n     */\n    aborted: boolean;\n\n    /**\n     * The response of the fetch task, represented as an `AsyncResult`.\n     */\n    response: FetchResponse<T>;\n}\n\n/**\n * Extends the standard `RequestInit` interface from the Fetch API to include additional custom options.\n */\nexport interface FetchInit extends RequestInit {\n    /**\n     * Indicates whether the fetch request should be abortable.\n     */\n    abortable?: boolean;\n\n    /**\n     * Specifies the expected response type of the fetch request.\n     */\n    responseType?: 'text' | 'arraybuffer' | 'blob' | 'json';\n\n    /**\n     * Specifies the maximum time in milliseconds to wait for the fetch request to complete.\n     */\n    timeout?: number;\n}\n\n/**\n * Name of abort error;\n */\nexport const ABORT_ERROR = 'AbortError';\n\n/**\n * Name of timeout error;\n */\nexport const TIMEOUT_ERROR = 'TimeoutError';","/* eslint-disable @typescript-eslint/no-explicit-any */\nimport { Err, Ok } from 'happy-rusty';\nimport invariant from 'tiny-invariant';\nimport { TIMEOUT_ERROR, type FetchInit, type FetchResponse, type FetchTask } from './defines.ts';\n\n/**\n * Fetches a resource from the network as a text string and returns a `FetchTask` representing the operation.\n *\n * @typeParam T - The expected type of the response data.\n * @param url - The resource to fetch. Can be a URL object or a string representing a URL.\n * @param init - Additional options for the fetch operation, including custom `FetchInit` properties.\n * @returns A `FetchTask` representing the operation with a `string` response.\n */\nexport function fetchT(url: string | URL, init: FetchInit & {\n    abortable: true;\n    responseType: 'text';\n}): FetchTask<string>;\n\n/**\n * Fetches a resource from the network as an ArrayBuffer and returns a `FetchTask` representing the operation.\n *\n * @param url - The resource to fetch. Can be a URL object or a string representing a URL.\n * @param init - Additional options for the fetch operation, including custom `FetchInit` properties.\n * @returns A `FetchTask` representing the operation with an `ArrayBuffer` response.\n */\nexport function fetchT(url: string | URL, init: FetchInit & {\n    abortable: true;\n    responseType: 'arraybuffer';\n}): FetchTask<ArrayBuffer>;\n\n/**\n * Fetches a resource from the network as a Blob and returns a `FetchTask` representing the operation.\n *\n * @param url - The resource to fetch. Can be a URL object or a string representing a URL.\n * @param init - Additional options for the fetch operation, including custom `FetchInit` properties.\n * @returns A `FetchTask` representing the operation with a `Blob` response.\n */\nexport function fetchT(url: string | URL, init: FetchInit & {\n    abortable: true;\n    responseType: 'blob';\n}): FetchTask<Blob>;\n\n/**\n * Fetches a resource from the network and parses it as JSON, returning a `FetchTask` representing the operation.\n *\n * @typeParam T - The expected type of the parsed JSON data.\n * @param url - The resource to fetch. Can be a URL object or a string representing a URL.\n * @param init - Additional options for the fetch operation, including custom `FetchInit` properties.\n * @returns A `FetchTask` representing the operation with a response parsed as JSON.\n */\nexport function fetchT<T>(url: string | URL, init: FetchInit & {\n    abortable: true;\n    responseType: 'json';\n}): FetchTask<T>;\n\n/**\n * Fetches a resource from the network as a text string and returns a `FetchResponse` representing the operation.\n *\n * @param url - The resource to fetch. Can be a URL object or a string representing a URL.\n * @param init - Additional options for the fetch operation, specifying the response type as 'text'.\n * @returns A `FetchResponse` representing the operation with a `string` response.\n */\nexport function fetchT(url: string | URL, init: FetchInit & {\n    responseType: 'text';\n}): FetchResponse<string>;\n\n/**\n * Fetches a resource from the network as an ArrayBuffer and returns a `FetchResponse` representing the operation.\n *\n * @param url - The resource to fetch. Can be a URL object or a string representing a URL.\n * @param init - Additional options for the fetch operation, specifying the response type as 'arraybuffer'.\n * @returns A `FetchResponse` representing the operation with an `ArrayBuffer` response.\n */\nexport function fetchT(url: string | URL, init: FetchInit & {\n    responseType: 'arraybuffer';\n}): FetchResponse<ArrayBuffer>;\n\n/**\n * Fetches a resource from the network as a Blob and returns a `FetchResponse` representing the operation.\n *\n * @param url - The resource to fetch. Can be a URL object or a string representing a URL.\n * @param init - Additional options for the fetch operation, specifying the response type as 'blob'.\n * @returns A `FetchResponse` representing the operation with a `Blob` response.\n */\nexport function fetchT(url: string | URL, init: FetchInit & {\n    responseType: 'blob';\n}): FetchResponse<Blob>;\n\n/**\n * Fetches a resource from the network and parses it as JSON, returning a `FetchResponse` representing the operation.\n *\n * @typeParam T - The expected type of the parsed JSON data.\n * @param url - The resource to fetch. Can be a URL object or a string representing a URL.\n * @param init - Additional options for the fetch operation, specifying the response type as 'json'.\n * @returns A `FetchResponse` representing the operation with a response parsed as JSON.\n */\nexport function fetchT<T>(url: string | URL, init: FetchInit & {\n    responseType: 'json';\n}): FetchResponse<T>;\n\n/**\n * Fetches a resource from the network and returns a `FetchTask` representing the operation with a generic `Response`.\n *\n * @param url - The resource to fetch. Can be a URL object or a string representing a URL.\n * @param init - Additional options for the fetch operation, indicating that the operation should be abortable.\n * @returns A `FetchTask` representing the operation with a generic `Response`.\n */\nexport function fetchT(url: string | URL, init: FetchInit & {\n    abortable: true;\n}): FetchTask<Response>;\n\n/**\n * Fetches a resource from the network and returns a `FetchResponse` representing the operation with a generic `Response`.\n *\n * @param url - The resource to fetch. Can be a URL object or a string representing a URL.\n * @param init - Additional options for the fetch operation, indicating that the operation should not be abortable.\n * @returns A `FetchResponse` representing the operation with a generic `Response`.\n */\nexport function fetchT(url: string | URL, init: FetchInit & {\n    abortable: false;\n}): FetchResponse<Response>;\n\n/**\n * Fetches a resource from the network and returns a `FetchResponse` representing the operation with a generic `Response`.\n *\n * @param url - The resource to fetch. Can be a URL object or a string representing a URL.\n * @param init - Additional options for the fetch operation, indicating that the operation should not be abortable.\n * @returns A `FetchResponse` representing the operation with a generic `Response`.\n */\nexport function fetchT(url: string | URL, init: FetchInit & {\n    timeout: number;\n}): FetchResponse<Response>;\n\n/**\n * Fetches a resource from the network and returns a `FetchResponse` or `FetchTask` based on the provided options.\n *\n * @typeParam T - The expected type of the response data when not using a specific `responseType`.\n * @param url - The resource to fetch. Can be a URL object or a string representing a URL.\n * @param init - Additional options for the fetch operation, including custom `FetchInit` properties.\n * @returns A `FetchResponse` or `FetchTask` depending on the `abortable` option in `init`.\n */\nexport function fetchT<T>(url: string | URL, init: FetchInit): FetchTask<T> | FetchResponse<T>;\n\n/**\n * Fetches a resource from the network and returns a `FetchResponse` representing the operation.\n *\n * @param url - The resource to fetch. Can be a URL object or a string representing a URL.\n * @param init - Standard `RequestInit` options for the fetch operation.\n * @returns A `FetchResponse` representing the operation with a `Response` object.\n */\nexport function fetchT(url: string | URL, init?: RequestInit): FetchResponse<Response>;\n\n/**\n * Fetches a resource from the network and returns either a `FetchTask` or `FetchResponse` based on the provided options.\n *\n * @typeParam T - The expected type of the response data when not using a specific `responseType`.\n * @param url - The resource to fetch. Can be a URL object or a string representing a URL.\n * @param init - Additional options for the fetch operation, including custom `FetchInit` properties.\n * @returns A `FetchTask` or `FetchResponse` depending on the provided options in `init`.\n */\nexport function fetchT<T>(url: string | URL, init?: FetchInit): FetchTask<T> | FetchResponse<T> {\n    // most cases\n    if (typeof url !== 'string') {\n        invariant(url instanceof URL, () => `Url must be a string or URL object but received ${ url }.`);\n    }\n\n    const {\n        // default not abort able\n        abortable = false,\n        responseType,\n        timeout,\n        ...rest\n    } = init ?? {};\n\n    const shouldWaitTimeout = timeout != null;\n\n    if (shouldWaitTimeout) {\n        invariant(typeof timeout === 'number' && timeout > 0, () => `Timeout must be a number greater than 0 but received ${ timeout }.`);\n    }\n\n    let controller: AbortController;\n\n    if (abortable || shouldWaitTimeout) {\n        controller = new AbortController();\n        rest.signal = controller.signal;\n    }\n\n    const response: FetchResponse<T> = fetch(url, rest).then(async (res): FetchResponse<T> => {\n        if (!res.ok) {\n            await res.body?.cancel();\n            return Err(new Error(`fetch status: ${ res.status }`));\n        }\n\n        switch (responseType) {\n            case 'arraybuffer': {\n                return Ok(await res.arrayBuffer() as T);\n            }\n            case 'blob': {\n                return Ok(await res.blob() as T);\n            }\n            case 'json': {\n                try {\n                    return Ok(await res.json() as T);\n                } catch {\n                    return Err(new Error('Response is invalid json while responseType is json'));\n                }\n            }\n            case 'text': {\n                return Ok(await res.text() as T);\n            }\n            default: {\n                // default return the Response object\n                return Ok(res as T);\n            }\n        }\n    }).catch((err) => {\n        return Err(err);\n    });\n\n    if (shouldWaitTimeout) {\n        setTimeout(() => {\n            if (!controller.signal.aborted) {\n                const error = new Error();\n                error.name = TIMEOUT_ERROR;\n                controller.abort(error);\n            }\n        }, timeout);\n    }\n\n    if (abortable) {\n        return {\n            abort(reason?: any): void {\n                controller.abort(reason);\n            },\n            get aborted(): boolean {\n                return controller.signal.aborted;\n            },\n            response,\n        };\n    } else {\n        return response;\n    }\n}"],"names":[],"mappings":";;;AAyDO,MAAM,WAAc,GAAA,aAAA;AAKpB,MAAM,aAAgB,GAAA;;ACkGb,SAAA,MAAA,CAAU,KAAmB,IAAmD,EAAA;AAE5F,EAAI,IAAA,OAAO,QAAQ,QAAU,EAAA;AACzB,IAAA,SAAA,CAAU,GAAe,YAAA,GAAA,EAAK,MAAM,CAAA,gDAAA,EAAoD,GAAI,CAAG,CAAA,CAAA,CAAA,CAAA;AAAA,GACnG;AAEA,EAAM,MAAA;AAAA;AAAA,IAEF,SAAY,GAAA,KAAA;AAAA,IACZ,YAAA;AAAA,IACA,OAAA;AAAA,IACA,GAAG,IAAA;AAAA,GACP,GAAI,QAAQ,EAAC,CAAA;AAEb,EAAA,MAAM,oBAAoB,OAAW,IAAA,IAAA,CAAA;AAErC,EAAA,IAAI,iBAAmB,EAAA;AACnB,IAAU,SAAA,CAAA,OAAO,YAAY,QAAY,IAAA,OAAA,GAAU,GAAG,MAAM,CAAA,qDAAA,EAAyD,OAAQ,CAAG,CAAA,CAAA,CAAA,CAAA;AAAA,GACpI;AAEA,EAAI,IAAA,UAAA,CAAA;AAEJ,EAAA,IAAI,aAAa,iBAAmB,EAAA;AAChC,IAAA,UAAA,GAAa,IAAI,eAAgB,EAAA,CAAA;AACjC,IAAA,IAAA,CAAK,SAAS,UAAW,CAAA,MAAA,CAAA;AAAA,GAC7B;AAEA,EAAA,MAAM,WAA6B,KAAM,CAAA,GAAA,EAAK,IAAI,CAAE,CAAA,IAAA,CAAK,OAAO,GAA0B,KAAA;AACtF,IAAI,IAAA,CAAC,IAAI,EAAI,EAAA;AACT,MAAM,MAAA,GAAA,CAAI,MAAM,MAAO,EAAA,CAAA;AACvB,MAAA,OAAO,IAAI,IAAI,KAAA,CAAM,iBAAkB,GAAI,CAAA,MAAO,EAAE,CAAC,CAAA,CAAA;AAAA,KACzD;AAEA,IAAA,QAAQ,YAAc;AAAA,MAClB,KAAK,aAAe,EAAA;AAChB,QAAA,OAAO,EAAG,CAAA,MAAM,GAAI,CAAA,WAAA,EAAkB,CAAA,CAAA;AAAA,OAC1C;AAAA,MACA,KAAK,MAAQ,EAAA;AACT,QAAA,OAAO,EAAG,CAAA,MAAM,GAAI,CAAA,IAAA,EAAW,CAAA,CAAA;AAAA,OACnC;AAAA,MACA,KAAK,MAAQ,EAAA;AACT,QAAI,IAAA;AACA,UAAA,OAAO,EAAG,CAAA,MAAM,GAAI,CAAA,IAAA,EAAW,CAAA,CAAA;AAAA,SAC3B,CAAA,MAAA;AACJ,UAAA,OAAO,GAAI,CAAA,IAAI,KAAM,CAAA,qDAAqD,CAAC,CAAA,CAAA;AAAA,SAC/E;AAAA,OACJ;AAAA,MACA,KAAK,MAAQ,EAAA;AACT,QAAA,OAAO,EAAG,CAAA,MAAM,GAAI,CAAA,IAAA,EAAW,CAAA,CAAA;AAAA,OACnC;AAAA,MACA,SAAS;AAEL,QAAA,OAAO,GAAG,GAAQ,CAAA,CAAA;AAAA,OACtB;AAAA,KACJ;AAAA,GACH,CAAA,CAAE,KAAM,CAAA,CAAC,GAAQ,KAAA;AACd,IAAA,OAAO,IAAI,GAAG,CAAA,CAAA;AAAA,GACjB,CAAA,CAAA;AAED,EAAA,IAAI,iBAAmB,EAAA;AACnB,IAAA,UAAA,CAAW,MAAM;AACb,MAAI,IAAA,CAAC,UAAW,CAAA,MAAA,CAAO,OAAS,EAAA;AAC5B,QAAM,MAAA,KAAA,GAAQ,IAAI,KAAM,EAAA,CAAA;AACxB,QAAA,KAAA,CAAM,IAAO,GAAA,aAAA,CAAA;AACb,QAAA,UAAA,CAAW,MAAM,KAAK,CAAA,CAAA;AAAA,OAC1B;AAAA,OACD,OAAO,CAAA,CAAA;AAAA,GACd;AAEA,EAAA,IAAI,SAAW,EAAA;AACX,IAAO,OAAA;AAAA,MACH,MAAM,MAAoB,EAAA;AACtB,QAAA,UAAA,CAAW,MAAM,MAAM,CAAA,CAAA;AAAA,OAC3B;AAAA,MACA,IAAI,OAAmB,GAAA;AACnB,QAAA,OAAO,WAAW,MAAO,CAAA,OAAA,CAAA;AAAA,OAC7B;AAAA,MACA,QAAA;AAAA,KACJ,CAAA;AAAA,GACG,MAAA;AACH,IAAO,OAAA,QAAA,CAAA;AAAA,GACX;AACJ;;;;"}

package/dist/types.d.ts

@@ -39,7 +39,19 @@ interface FetchInit extends RequestInit {
      * Specifies the expected response type of the fetch request.
      */
     responseType?: 'text' | 'arraybuffer' | 'blob' | 'json';
+    /**
+     * Specifies the maximum time in milliseconds to wait for the fetch request to complete.
+     */
+    timeout?: number;
 }
+/**
+ * Name of abort error;
+ */
+declare const ABORT_ERROR = "AbortError";
+/**
+ * Name of timeout error;
+ */
+declare const TIMEOUT_ERROR = "TimeoutError";
 
 /**
  * Fetches a resource from the network as a text string and returns a `FetchTask` representing the operation.
@@ -148,6 +160,16 @@ declare function fetchT(url: string | URL, init: FetchInit & {
 declare function fetchT(url: string | URL, init: FetchInit & {
     abortable: false;
 }): FetchResponse<Response>;
+/**
+ * Fetches a resource from the network and returns a `FetchResponse` representing the operation with a generic `Response`.
+ *
+ * @param url - The resource to fetch. Can be a URL object or a string representing a URL.
+ * @param init - Additional options for the fetch operation, indicating that the operation should not be abortable.
+ * @returns A `FetchResponse` representing the operation with a generic `Response`.
+ */
+declare function fetchT(url: string | URL, init: FetchInit & {
+    timeout: number;
+}): FetchResponse<Response>;
 /**
  * Fetches a resource from the network and returns a `FetchResponse` or `FetchTask` based on the provided options.
  *
@@ -166,5 +188,5 @@ declare function fetchT<T>(url: string | URL, init: FetchInit): FetchTask<T> | F
  */
 declare function fetchT(url: string | URL, init?: RequestInit): FetchResponse<Response>;
 
-export { type FetchInit, type FetchResponse, type FetchTask, fetchT };
+export { ABORT_ERROR, type FetchInit, type FetchResponse, type FetchTask, TIMEOUT_ERROR, fetchT };
 //# sourceMappingURL=types.d.ts.map

package/docs/README.md

@@ -17,6 +17,13 @@
 | ------ | ------ |
 | [FetchResponse](type-aliases/FetchResponse.md) | Represents the response of a fetch operation, encapsulating the result data or any error that occurred. |
 
+## Variables
+
+| Variable | Description |
+| ------ | ------ |
+| [ABORT\_ERROR](variables/ABORT_ERROR.md) | Name of abort error; |
+| [TIMEOUT\_ERROR](variables/TIMEOUT_ERROR.md) | Name of timeout error; |
+
 ## Functions
 
 | Function | Description |

package/docs/functions/fetchT.md

@@ -39,11 +39,23 @@ Fetches a resource from the network as a text string and returns a `FetchTask` r
 
 [`FetchTask`](../interfaces/FetchTask.md)\<`string`\>
 
-A `FetchTask` representing the operation with a `string` response.
+A `FetchTask` or `FetchResponse` depending on the provided options in `init`.
+
+### Type Param
+
+The expected type of the response data when not using a specific `responseType`.
+
+### Param
+
+The resource to fetch. Can be a URL object or a string representing a URL.
+
+### Param
+
+Additional options for the fetch operation, including custom `FetchInit` properties.
 
 ### Defined in
 
-[fetch.ts:14](https://github.com/JiangJie/fetch-t/blob/e5aa635435bb73b90ba7373357fa4cc6928da1b3/src/fetch/fetch.ts#L14)
+[fetch.ts:14](https://github.com/JiangJie/fetch-t/blob/c5e0121b76a0dea415931120c31c2d070cc2469d/src/fetch/fetch.ts#L14)
 
 ## fetchT(url, init)
 
@@ -64,11 +76,23 @@ Fetches a resource from the network as an ArrayBuffer and returns a `FetchTask`
 
 [`FetchTask`](../interfaces/FetchTask.md)\<`ArrayBuffer`\>
 
-A `FetchTask` representing the operation with an `ArrayBuffer` response.
+A `FetchTask` or `FetchResponse` depending on the provided options in `init`.
+
+### Type Param
+
+The expected type of the response data when not using a specific `responseType`.
+
+### Param
+
+The resource to fetch. Can be a URL object or a string representing a URL.
+
+### Param
+
+Additional options for the fetch operation, including custom `FetchInit` properties.
 
 ### Defined in
 
-[fetch.ts:26](https://github.com/JiangJie/fetch-t/blob/e5aa635435bb73b90ba7373357fa4cc6928da1b3/src/fetch/fetch.ts#L26)
+[fetch.ts:26](https://github.com/JiangJie/fetch-t/blob/c5e0121b76a0dea415931120c31c2d070cc2469d/src/fetch/fetch.ts#L26)
 
 ## fetchT(url, init)
 
@@ -89,11 +113,23 @@ Fetches a resource from the network as a Blob and returns a `FetchTask` represen
 
 [`FetchTask`](../interfaces/FetchTask.md)\<`Blob`\>
 
-A `FetchTask` representing the operation with a `Blob` response.
+A `FetchTask` or `FetchResponse` depending on the provided options in `init`.
+
+### Type Param
+
+The expected type of the response data when not using a specific `responseType`.
+
+### Param
+
+The resource to fetch. Can be a URL object or a string representing a URL.
+
+### Param
+
+Additional options for the fetch operation, including custom `FetchInit` properties.
 
 ### Defined in
 
-[fetch.ts:38](https://github.com/JiangJie/fetch-t/blob/e5aa635435bb73b90ba7373357fa4cc6928da1b3/src/fetch/fetch.ts#L38)
+[fetch.ts:38](https://github.com/JiangJie/fetch-t/blob/c5e0121b76a0dea415931120c31c2d070cc2469d/src/fetch/fetch.ts#L38)
 
 ## fetchT(url, init)
 
@@ -120,11 +156,23 @@ Fetches a resource from the network and parses it as JSON, returning a `FetchTas
 
 [`FetchTask`](../interfaces/FetchTask.md)\<`T`\>
 
-A `FetchTask` representing the operation with a response parsed as JSON.
+A `FetchTask` or `FetchResponse` depending on the provided options in `init`.
+
+### Type Param
+
+The expected type of the response data when not using a specific `responseType`.
+
+### Param
+
+The resource to fetch. Can be a URL object or a string representing a URL.
+
+### Param
+
+Additional options for the fetch operation, including custom `FetchInit` properties.
 
 ### Defined in
 
-[fetch.ts:51](https://github.com/JiangJie/fetch-t/blob/e5aa635435bb73b90ba7373357fa4cc6928da1b3/src/fetch/fetch.ts#L51)
+[fetch.ts:51](https://github.com/JiangJie/fetch-t/blob/c5e0121b76a0dea415931120c31c2d070cc2469d/src/fetch/fetch.ts#L51)
 
 ## fetchT(url, init)
 
@@ -145,11 +193,23 @@ Fetches a resource from the network as a text string and returns a `FetchRespons
 
 [`FetchResponse`](../type-aliases/FetchResponse.md)\<`string`\>
 
-A `FetchResponse` representing the operation with a `string` response.
+A `FetchTask` or `FetchResponse` depending on the provided options in `init`.
+
+### Type Param
+
+The expected type of the response data when not using a specific `responseType`.
+
+### Param
+
+The resource to fetch. Can be a URL object or a string representing a URL.
+
+### Param
+
+Additional options for the fetch operation, including custom `FetchInit` properties.
 
 ### Defined in
 
-[fetch.ts:63](https://github.com/JiangJie/fetch-t/blob/e5aa635435bb73b90ba7373357fa4cc6928da1b3/src/fetch/fetch.ts#L63)
+[fetch.ts:63](https://github.com/JiangJie/fetch-t/blob/c5e0121b76a0dea415931120c31c2d070cc2469d/src/fetch/fetch.ts#L63)
 
 ## fetchT(url, init)
 
@@ -170,11 +230,23 @@ Fetches a resource from the network as an ArrayBuffer and returns a `FetchRespon
 
 [`FetchResponse`](../type-aliases/FetchResponse.md)\<`ArrayBuffer`\>
 
-A `FetchResponse` representing the operation with an `ArrayBuffer` response.
+A `FetchTask` or `FetchResponse` depending on the provided options in `init`.
+
+### Type Param
+
+The expected type of the response data when not using a specific `responseType`.
+
+### Param
+
+The resource to fetch. Can be a URL object or a string representing a URL.
+
+### Param
+
+Additional options for the fetch operation, including custom `FetchInit` properties.
 
 ### Defined in
 
-[fetch.ts:74](https://github.com/JiangJie/fetch-t/blob/e5aa635435bb73b90ba7373357fa4cc6928da1b3/src/fetch/fetch.ts#L74)
+[fetch.ts:74](https://github.com/JiangJie/fetch-t/blob/c5e0121b76a0dea415931120c31c2d070cc2469d/src/fetch/fetch.ts#L74)
 
 ## fetchT(url, init)
 
@@ -195,11 +267,23 @@ Fetches a resource from the network as a Blob and returns a `FetchResponse` repr
 
 [`FetchResponse`](../type-aliases/FetchResponse.md)\<`Blob`\>
 
-A `FetchResponse` representing the operation with a `Blob` response.
+A `FetchTask` or `FetchResponse` depending on the provided options in `init`.
+
+### Type Param
+
+The expected type of the response data when not using a specific `responseType`.
+
+### Param
+
+The resource to fetch. Can be a URL object or a string representing a URL.
+
+### Param
+
+Additional options for the fetch operation, including custom `FetchInit` properties.
 
 ### Defined in
 
-[fetch.ts:85](https://github.com/JiangJie/fetch-t/blob/e5aa635435bb73b90ba7373357fa4cc6928da1b3/src/fetch/fetch.ts#L85)
+[fetch.ts:85](https://github.com/JiangJie/fetch-t/blob/c5e0121b76a0dea415931120c31c2d070cc2469d/src/fetch/fetch.ts#L85)
 
 ## fetchT(url, init)
 
@@ -226,11 +310,23 @@ Fetches a resource from the network and parses it as JSON, returning a `FetchRes
 
 [`FetchResponse`](../type-aliases/FetchResponse.md)\<`T`\>
 
-A `FetchResponse` representing the operation with a response parsed as JSON.
+A `FetchTask` or `FetchResponse` depending on the provided options in `init`.
+
+### Type Param
+
+The expected type of the response data when not using a specific `responseType`.
+
+### Param
+
+The resource to fetch. Can be a URL object or a string representing a URL.
+
+### Param
+
+Additional options for the fetch operation, including custom `FetchInit` properties.
 
 ### Defined in
 
-[fetch.ts:97](https://github.com/JiangJie/fetch-t/blob/e5aa635435bb73b90ba7373357fa4cc6928da1b3/src/fetch/fetch.ts#L97)
+[fetch.ts:97](https://github.com/JiangJie/fetch-t/blob/c5e0121b76a0dea415931120c31c2d070cc2469d/src/fetch/fetch.ts#L97)
 
 ## fetchT(url, init)
 
@@ -251,11 +347,23 @@ Fetches a resource from the network and returns a `FetchTask` representing the o
 
 [`FetchTask`](../interfaces/FetchTask.md)\<`Response`\>
 
-A `FetchTask` representing the operation with a generic `Response`.
+A `FetchTask` or `FetchResponse` depending on the provided options in `init`.
+
+### Type Param
+
+The expected type of the response data when not using a specific `responseType`.
+
+### Param
+
+The resource to fetch. Can be a URL object or a string representing a URL.
+
+### Param
+
+Additional options for the fetch operation, including custom `FetchInit` properties.
 
 ### Defined in
 
-[fetch.ts:108](https://github.com/JiangJie/fetch-t/blob/e5aa635435bb73b90ba7373357fa4cc6928da1b3/src/fetch/fetch.ts#L108)
+[fetch.ts:108](https://github.com/JiangJie/fetch-t/blob/c5e0121b76a0dea415931120c31c2d070cc2469d/src/fetch/fetch.ts#L108)
 
 ## fetchT(url, init)
 
@@ -276,11 +384,60 @@ Fetches a resource from the network and returns a `FetchResponse` representing t
 
 [`FetchResponse`](../type-aliases/FetchResponse.md)\<`Response`\>
 
-A `FetchResponse` representing the operation with a generic `Response`.
+A `FetchTask` or `FetchResponse` depending on the provided options in `init`.
+
+### Type Param
+
+The expected type of the response data when not using a specific `responseType`.
+
+### Param
+
+The resource to fetch. Can be a URL object or a string representing a URL.
+
+### Param
+
+Additional options for the fetch operation, including custom `FetchInit` properties.
 
 ### Defined in
 
-[fetch.ts:119](https://github.com/JiangJie/fetch-t/blob/e5aa635435bb73b90ba7373357fa4cc6928da1b3/src/fetch/fetch.ts#L119)
+[fetch.ts:119](https://github.com/JiangJie/fetch-t/blob/c5e0121b76a0dea415931120c31c2d070cc2469d/src/fetch/fetch.ts#L119)
+
+## fetchT(url, init)
+
+```ts
+function fetchT(url, init): FetchResponse<Response>
+```
+
+Fetches a resource from the network and returns a `FetchResponse` representing the operation with a generic `Response`.
+
+### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `url` | `string` \| `URL` | The resource to fetch. Can be a URL object or a string representing a URL. |
+| `init` | [`FetchInit`](../interfaces/FetchInit.md) & \{ `timeout`: `number`; \} | Additional options for the fetch operation, indicating that the operation should not be abortable. |
+
+### Returns
+
+[`FetchResponse`](../type-aliases/FetchResponse.md)\<`Response`\>
+
+A `FetchTask` or `FetchResponse` depending on the provided options in `init`.
+
+### Type Param
+
+The expected type of the response data when not using a specific `responseType`.
+
+### Param
+
+The resource to fetch. Can be a URL object or a string representing a URL.
+
+### Param
+
+Additional options for the fetch operation, including custom `FetchInit` properties.
+
+### Defined in
+
+[fetch.ts:130](https://github.com/JiangJie/fetch-t/blob/c5e0121b76a0dea415931120c31c2d070cc2469d/src/fetch/fetch.ts#L130)
 
 ## fetchT(url, init)
 
@@ -307,11 +464,23 @@ Fetches a resource from the network and returns a `FetchResponse` or `FetchTask`
 
 [`FetchTask`](../interfaces/FetchTask.md)\<`T`\> \| [`FetchResponse`](../type-aliases/FetchResponse.md)\<`T`\>
 
-A `FetchResponse` or `FetchTask` depending on the `abortable` option in `init`.
+A `FetchTask` or `FetchResponse` depending on the provided options in `init`.
+
+### Type Param
+
+The expected type of the response data when not using a specific `responseType`.
+
+### Param
+
+The resource to fetch. Can be a URL object or a string representing a URL.
+
+### Param
+
+Additional options for the fetch operation, including custom `FetchInit` properties.
 
 ### Defined in
 
-[fetch.ts:131](https://github.com/JiangJie/fetch-t/blob/e5aa635435bb73b90ba7373357fa4cc6928da1b3/src/fetch/fetch.ts#L131)
+[fetch.ts:142](https://github.com/JiangJie/fetch-t/blob/c5e0121b76a0dea415931120c31c2d070cc2469d/src/fetch/fetch.ts#L142)
 
 ## fetchT(url, init)
 
@@ -332,8 +501,20 @@ Fetches a resource from the network and returns a `FetchResponse` representing t
 
 [`FetchResponse`](../type-aliases/FetchResponse.md)\<`Response`\>
 
-A `FetchResponse` representing the operation with a `Response` object.
+A `FetchTask` or `FetchResponse` depending on the provided options in `init`.
+
+### Type Param
+
+The expected type of the response data when not using a specific `responseType`.
+
+### Param
+
+The resource to fetch. Can be a URL object or a string representing a URL.
+
+### Param
+
+Additional options for the fetch operation, including custom `FetchInit` properties.
 
 ### Defined in
 
-[fetch.ts:140](https://github.com/JiangJie/fetch-t/blob/e5aa635435bb73b90ba7373357fa4cc6928da1b3/src/fetch/fetch.ts#L140)
+[fetch.ts:151](https://github.com/JiangJie/fetch-t/blob/c5e0121b76a0dea415931120c31c2d070cc2469d/src/fetch/fetch.ts#L151)

package/docs/interfaces/FetchInit.md

@@ -16,5 +16,6 @@ Extends the standard `RequestInit` interface from the Fetch API to include addit
 
 | Property | Type | Description | Defined in |
 | ------ | ------ | ------ | ------ |
-| `abortable?` | `boolean` | Indicates whether the fetch request should be abortable. | [defines.ts:42](https://github.com/JiangJie/fetch-t/blob/e5aa635435bb73b90ba7373357fa4cc6928da1b3/src/fetch/defines.ts#L42) |
-| `responseType?` | `"text"` \| `"arraybuffer"` \| `"blob"` \| `"json"` | Specifies the expected response type of the fetch request. | [defines.ts:47](https://github.com/JiangJie/fetch-t/blob/e5aa635435bb73b90ba7373357fa4cc6928da1b3/src/fetch/defines.ts#L47) |
+| `abortable?` | `boolean` | Indicates whether the fetch request should be abortable. | [defines.ts:42](https://github.com/JiangJie/fetch-t/blob/c5e0121b76a0dea415931120c31c2d070cc2469d/src/fetch/defines.ts#L42) |
+| `responseType?` | `"text"` \| `"arraybuffer"` \| `"blob"` \| `"json"` | Specifies the expected response type of the fetch request. | [defines.ts:47](https://github.com/JiangJie/fetch-t/blob/c5e0121b76a0dea415931120c31c2d070cc2469d/src/fetch/defines.ts#L47) |
+| `timeout?` | `number` | Specifies the maximum time in milliseconds to wait for the fetch request to complete. | [defines.ts:52](https://github.com/JiangJie/fetch-t/blob/c5e0121b76a0dea415931120c31c2d070cc2469d/src/fetch/defines.ts#L52) |

package/docs/interfaces/FetchTask.md

@@ -18,8 +18,8 @@ Defines the structure and behavior of a fetch task, including the ability to abo
 
 | Property | Type | Description | Defined in |
 | ------ | ------ | ------ | ------ |
-| `aborted` | `boolean` | Indicates whether the fetch task has been aborted. | [defines.ts:27](https://github.com/JiangJie/fetch-t/blob/e5aa635435bb73b90ba7373357fa4cc6928da1b3/src/fetch/defines.ts#L27) |
-| `response` | [`FetchResponse`](../type-aliases/FetchResponse.md)\<`T`\> | The response of the fetch task, represented as an `AsyncResult`. | [defines.ts:32](https://github.com/JiangJie/fetch-t/blob/e5aa635435bb73b90ba7373357fa4cc6928da1b3/src/fetch/defines.ts#L32) |
+| `aborted` | `boolean` | Indicates whether the fetch task has been aborted. | [defines.ts:27](https://github.com/JiangJie/fetch-t/blob/c5e0121b76a0dea415931120c31c2d070cc2469d/src/fetch/defines.ts#L27) |
+| `response` | [`FetchResponse`](../type-aliases/FetchResponse.md)\<`T`\> | The response of the fetch task, represented as an `AsyncResult`. | [defines.ts:32](https://github.com/JiangJie/fetch-t/blob/c5e0121b76a0dea415931120c31c2d070cc2469d/src/fetch/defines.ts#L32) |
 
 ## Methods
 
@@ -43,4 +43,4 @@ Aborts the fetch task, optionally with a reason for the abortion.
 
 #### Defined in
 
-[defines.ts:22](https://github.com/JiangJie/fetch-t/blob/e5aa635435bb73b90ba7373357fa4cc6928da1b3/src/fetch/defines.ts#L22)
+[defines.ts:22](https://github.com/JiangJie/fetch-t/blob/c5e0121b76a0dea415931120c31c2d070cc2469d/src/fetch/defines.ts#L22)

package/docs/type-aliases/FetchResponse.md

@@ -20,4 +20,4 @@ Represents the response of a fetch operation, encapsulating the result data or a
 
 ## Defined in
 
-[defines.ts:9](https://github.com/JiangJie/fetch-t/blob/e5aa635435bb73b90ba7373357fa4cc6928da1b3/src/fetch/defines.ts#L9)
+[defines.ts:9](https://github.com/JiangJie/fetch-t/blob/c5e0121b76a0dea415931120c31c2d070cc2469d/src/fetch/defines.ts#L9)

package/docs/variables/ABORT_ERROR.md

@@ -0,0 +1,17 @@
+[**@happy-ts/fetch-t**](../README.md) • **Docs**
+
+***
+
+[@happy-ts/fetch-t](../README.md) / ABORT\_ERROR
+
+# Variable: ABORT\_ERROR
+
+```ts
+const ABORT_ERROR: "AbortError" = 'AbortError';
+```
+
+Name of abort error;
+
+## Defined in
+
+[defines.ts:58](https://github.com/JiangJie/fetch-t/blob/c5e0121b76a0dea415931120c31c2d070cc2469d/src/fetch/defines.ts#L58)

package/docs/variables/TIMEOUT_ERROR.md

@@ -0,0 +1,17 @@
+[**@happy-ts/fetch-t**](../README.md) • **Docs**
+
+***
+
+[@happy-ts/fetch-t](../README.md) / TIMEOUT\_ERROR
+
+# Variable: TIMEOUT\_ERROR
+
+```ts
+const TIMEOUT_ERROR: "TimeoutError" = 'TimeoutError';
+```
+
+Name of timeout error;
+
+## Defined in
+
+[defines.ts:63](https://github.com/JiangJie/fetch-t/blob/c5e0121b76a0dea415931120c31c2d070cc2469d/src/fetch/defines.ts#L63)

package/package.json

@@ -3,7 +3,7 @@
   "description": "Abortable fetch wrapper with the ability to specify the return type.",
   "author": "jiang115jie@gmail.com",
   "license": "GPL-3.0",
-  "version": "1.0.11",
+  "version": "1.0.13",
   "type": "module",
   "source": "src/mod.ts",
   "main": "dist/main.cjs",
@@ -43,15 +43,15 @@
     "responseType"
   ],
   "devDependencies": {
-    "@typescript-eslint/eslint-plugin": "^7.16.1",
-    "@typescript-eslint/parser": "^7.16.1",
+    "@typescript-eslint/eslint-plugin": "^7.17.0",
+    "@typescript-eslint/parser": "^7.17.0",
     "eslint": "^8.57.0",
-    "rollup": "^4.18.1",
+    "rollup": "^4.19.0",
     "rollup-plugin-dts": "^6.1.1",
     "rollup-plugin-esbuild": "^6.1.1",
-    "typedoc": "^0.26.4",
-    "typedoc-plugin-markdown": "^4.2.1",
-    "typescript": "^5.5.3"
+    "typedoc": "^0.26.5",
+    "typedoc-plugin-markdown": "^4.2.2",
+    "typescript": "^5.5.4"
   },
   "dependencies": {
     "happy-rusty": "^1.1.2",

package/src/fetch/defines.ts

@@ -45,4 +45,19 @@ export interface FetchInit extends RequestInit {
      * Specifies the expected response type of the fetch request.
      */
     responseType?: 'text' | 'arraybuffer' | 'blob' | 'json';
-}
+
+    /**
+     * Specifies the maximum time in milliseconds to wait for the fetch request to complete.
+     */
+    timeout?: number;
+}
+
+/**
+ * Name of abort error;
+ */
+export const ABORT_ERROR = 'AbortError';
+
+/**
+ * Name of timeout error;
+ */
+export const TIMEOUT_ERROR = 'TimeoutError';

package/src/fetch/fetch.ts

@@ -1,7 +1,7 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
 import { Err, Ok } from 'happy-rusty';
 import invariant from 'tiny-invariant';
-import type { FetchInit, FetchResponse, FetchTask } from './defines.ts';
+import { TIMEOUT_ERROR, type FetchInit, type FetchResponse, type FetchTask } from './defines.ts';
 
 /**
  * Fetches a resource from the network as a text string and returns a `FetchTask` representing the operation.
@@ -120,6 +120,17 @@ export function fetchT(url: string | URL, init: FetchInit & {
     abortable: false;
 }): FetchResponse<Response>;
 
+/**
+ * Fetches a resource from the network and returns a `FetchResponse` representing the operation with a generic `Response`.
+ *
+ * @param url - The resource to fetch. Can be a URL object or a string representing a URL.
+ * @param init - Additional options for the fetch operation, indicating that the operation should not be abortable.
+ * @returns A `FetchResponse` representing the operation with a generic `Response`.
+ */
+export function fetchT(url: string | URL, init: FetchInit & {
+    timeout: number;
+}): FetchResponse<Response>;
+
 /**
  * Fetches a resource from the network and returns a `FetchResponse` or `FetchTask` based on the provided options.
  *
@@ -153,12 +164,23 @@ export function fetchT<T>(url: string | URL, init?: FetchInit): FetchTask<T> | F
         invariant(url instanceof URL, () => `Url must be a string or URL object but received ${ url }.`);
     }
 
-    // default not abort able
-    const { abortable = false, responseType, ...rest } = init ?? {};
+    const {
+        // default not abort able
+        abortable = false,
+        responseType,
+        timeout,
+        ...rest
+    } = init ?? {};
+
+    const shouldWaitTimeout = timeout != null;
+
+    if (shouldWaitTimeout) {
+        invariant(typeof timeout === 'number' && timeout > 0, () => `Timeout must be a number greater than 0 but received ${ timeout }.`);
+    }
 
     let controller: AbortController;
 
-    if (abortable) {
+    if (abortable || shouldWaitTimeout) {
         controller = new AbortController();
         rest.signal = controller.signal;
     }
@@ -195,6 +217,16 @@ export function fetchT<T>(url: string | URL, init?: FetchInit): FetchTask<T> | F
         return Err(err);
     });
 
+    if (shouldWaitTimeout) {
+        setTimeout(() => {
+            if (!controller.signal.aborted) {
+                const error = new Error();
+                error.name = TIMEOUT_ERROR;
+                controller.abort(error);
+            }
+        }, timeout);
+    }
+
     if (abortable) {
         return {
             abort(reason?: any): void {

package/src/mod.ts

@@ -1,2 +1,2 @@
-export type { FetchInit, FetchResponse, FetchTask } from './fetch/defines.ts';
+export * from './fetch/defines.ts';
 export { fetchT } from './fetch/fetch.ts';