@happy-ts/fetch-t 1.0.8 → 1.0.9

package/README.cn.md

@@ -4,6 +4,7 @@
 [![JSR Version](https://jsr.io/badges/@happy-ts/fetch-t)](https://jsr.io/@happy-ts/fetch-t)
 [![JSR Score](https://jsr.io/badges/@happy-ts/fetch-t/score)](https://jsr.io/@happy-ts/fetch-t/score)
 [![Build Status](https://github.com/jiangjie/fetch-t/actions/workflows/test.yml/badge.svg)](https://github.com/jiangjie/fetch-t/actions/workflows/test.yml)
+[![codecov](https://codecov.io/gh/JiangJie/fetch-t/graph/badge.svg)](https://codecov.io/gh/JiangJie/fetch-t)
 
 ---
 
@@ -70,10 +71,12 @@ somethingHappenAsync(() => {
 
 const res = await fetchTask.response;
 if (res.isErr()) {
-    console.assert(res.err() === 'cancel');
+    console.assert(res.unwrapErr() === 'cancel');
 } else {
     console.log(res.unwrap());
 }
 ```
 
-更多示例可参见测试用例 <a href="tests/fetch.test.ts">fetch.test.ts</a>。
+更多示例可参见测试用例 <a href="tests/fetch.test.ts">fetch.test.ts</a>。
+
+## [文档](docs/index.md)

package/README.md

@@ -5,10 +5,11 @@
 [![JSR Version](https://jsr.io/badges/@happy-ts/fetch-t)](https://jsr.io/@happy-ts/fetch-t)
 [![JSR Score](https://jsr.io/badges/@happy-ts/fetch-t/score)](https://jsr.io/@happy-ts/fetch-t/score)
 [![Build Status](https://github.com/jiangjie/fetch-t/actions/workflows/test.yml/badge.svg)](https://github.com/jiangjie/fetch-t/actions/workflows/test.yml)
+[![codecov](https://codecov.io/gh/JiangJie/fetch-t/graph/badge.svg)](https://codecov.io/gh/JiangJie/fetch-t)
 
 ---
 
-<a href="README.cn.md">[中文]</a>
+## [中文](README.cn.md)
 
 ---
 
@@ -81,10 +82,12 @@ somethingHappenAsync(() => {
 
 const res = await fetchTask.response;
 if (res.isErr()) {
-    console.assert(res.err() === 'cancel');
+    console.assert(res.unwrapErr() === 'cancel');
 } else {
     console.log(res.unwrap());
 }
 ```
 
 For more examples, please refer to test case <a href="tests/fetch.test.ts">fetch.test.ts</a>.
+
+## [Docs](docs/index.md)

package/dist/main.cjs

@@ -1,19 +1,11 @@
 'use strict';
 
 var happyRusty = require('happy-rusty');
-
-function invariant(expr, createMsg) {
-  if (!expr) {
-    throw new TypeError(createMsg());
-  }
-}
-function assertURL(url) {
-  invariant(url instanceof URL, () => `Url must be an URL object. Received ${JSON.stringify(url)}`);
-}
+var invariant = require('tiny-invariant');
 
 function fetchT(url, init) {
   if (typeof url !== "string") {
-    assertURL(url);
+    invariant(url instanceof URL, () => `Url must be a string or URL object but received ${url}.`);
   }
   const { abortable = false, responseType, ...rest } = init ?? {};
   let controller;
@@ -23,6 +15,7 @@ function fetchT(url, init) {
   }
   const response = fetch(url, rest).then(async (res) => {
     if (!res.ok) {
+      await res.body?.cancel();
       return happyRusty.Err(new Error(`fetch status: ${res.status}`));
     }
     switch (responseType) {

package/dist/main.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"main.cjs","sources":["../src/fetch/assertions.ts","../src/fetch/fetch.ts"],"sourcesContent":["/**\n * assert function\n * @param expr\n * @param createMsg return a string message to throw\n */\nfunction invariant(expr: unknown, createMsg: () => string): void {\n    if (!expr) {\n        throw new TypeError(createMsg());\n    }\n}\n\n/**\n * assert url is an URL object\n *\n * @param url\n */\nexport function assertURL(url: URL): void {\n    invariant(url instanceof URL, () => `Url must be an URL object. Received ${ JSON.stringify(url) }`);\n}","/* eslint-disable @typescript-eslint/no-explicit-any */\nimport { Err, Ok } from 'happy-rusty';\nimport { assertURL } from './assertions.ts';\nimport type { FetchInit, FetchResponse, FetchTask } from './defines.ts';\n\n/**\n * Return `FetchTask<string>`.\n * @param url\n * @param init\n */\nexport function fetchT(url: string | URL, init: FetchInit & {\n    abortable: true;\n    responseType: 'text';\n}): FetchTask<string>;\n/**\n * Return `FetchTask<ArrayBuffer>`.\n * @param url\n * @param init\n */\nexport function fetchT(url: string | URL, init: FetchInit & {\n    abortable: true;\n    responseType: 'arraybuffer';\n}): FetchTask<ArrayBuffer>;\n/**\n * Return `FetchTask<Blob>`.\n * @param url\n * @param init\n */\nexport function fetchT(url: string | URL, init: FetchInit & {\n    abortable: true;\n    responseType: 'blob';\n}): FetchTask<Blob>;\n/**\n * Return `FetchTask<T>`.\n */\nexport function fetchT<T>(url: string | URL, init: FetchInit & {\n    abortable: true;\n    responseType: 'json';\n}): FetchTask<T>;\n/**\n * Return `FetchResponse<string>`.\n * @param url\n * @param init\n */\nexport function fetchT(url: string | URL, init: FetchInit & {\n    responseType: 'text';\n}): FetchResponse<string>;\n/**\n * Return `FetchResponse<ArrayBuffer>`.\n * @param url\n * @param init\n */\nexport function fetchT(url: string | URL, init: FetchInit & {\n    responseType: 'arraybuffer';\n}): FetchResponse<ArrayBuffer>;\n/**\n * Return `FetchResponse<Blob>`.\n * @param url\n * @param init\n */\nexport function fetchT(url: string | URL, init: FetchInit & {\n    responseType: 'blob';\n}): FetchResponse<Blob>;\n/**\n * Return `FetchResponse<T>`.\n * @param url\n * @param init\n */\nexport function fetchT<T>(url: string | URL, init: FetchInit & {\n    responseType: 'json';\n}): FetchResponse<T>;\n/**\n * Return `FetchTask<Response>`.\n * @param url\n * @param init\n */\nexport function fetchT(url: string | URL, init: FetchInit & {\n    abortable: true;\n}): FetchTask<Response>;\n/**\n * Return `FetchResponse<Response>`.\n * @param url\n * @param init\n */\nexport function fetchT(url: string | URL, init: FetchInit & {\n    abortable: false;\n}): FetchResponse<Response>;\n/**\n * Return `FetchTask<T>` or `FetchResponse<T>`.\n * @param url\n * @param init\n */\nexport function fetchT<T = any>(url: string | URL, init: FetchInit): FetchTask<T> | FetchResponse<T>;\n/**\n * Return `FetchResponse<Response>`.\n * @param url\n * @param init\n */\nexport function fetchT(url: string | URL, init?: RequestInit): FetchResponse<Response>;\n/**\n * Request the url and return the corresponding type based on the responseType.\n * @param url url to fetch\n * @param init fetch init\n * @returns {FetchTask<T> | FetchResponse<T>} an abort able fetch task or just response\n */\nexport function fetchT<T = any>(url: string | URL, init?: FetchInit): FetchTask<T> | FetchResponse<T> {\n    if (typeof url !== 'string') {\n        assertURL(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            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":";;;;AAKA,SAAS,SAAA,CAAU,MAAe,SAA+B,EAAA;AAC7D,EAAA,IAAI,CAAC,IAAM,EAAA;AACP,IAAM,MAAA,IAAI,SAAU,CAAA,SAAA,EAAW,CAAA,CAAA;AAAA,GACnC;AACJ,CAAA;AAOO,SAAS,UAAU,GAAgB,EAAA;AACtC,EAAU,SAAA,CAAA,GAAA,YAAe,KAAK,MAAM,CAAA,oCAAA,EAAwC,KAAK,SAAU,CAAA,GAAG,CAAE,CAAE,CAAA,CAAA,CAAA;AACtG;;ACuFgB,SAAA,MAAA,CAAgB,KAAmB,IAAmD,EAAA;AAClG,EAAI,IAAA,OAAO,QAAQ,QAAU,EAAA;AACzB,IAAA,SAAA,CAAU,GAAG,CAAA,CAAA;AAAA,GACjB;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,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/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;;;;"}

package/dist/main.mjs

@@ -1,17 +1,9 @@
 import { Err, Ok } from 'happy-rusty';
-
-function invariant(expr, createMsg) {
-  if (!expr) {
-    throw new TypeError(createMsg());
-  }
-}
-function assertURL(url) {
-  invariant(url instanceof URL, () => `Url must be an URL object. Received ${JSON.stringify(url)}`);
-}
+import invariant from 'tiny-invariant';
 
 function fetchT(url, init) {
   if (typeof url !== "string") {
-    assertURL(url);
+    invariant(url instanceof URL, () => `Url must be a string or URL object but received ${url}.`);
   }
   const { abortable = false, responseType, ...rest } = init ?? {};
   let controller;
@@ -21,6 +13,7 @@ function fetchT(url, init) {
   }
   const response = fetch(url, rest).then(async (res) => {
     if (!res.ok) {
+      await res.body?.cancel();
       return Err(new Error(`fetch status: ${res.status}`));
     }
     switch (responseType) {

package/dist/main.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"main.mjs","sources":["../src/fetch/assertions.ts","../src/fetch/fetch.ts"],"sourcesContent":["/**\n * assert function\n * @param expr\n * @param createMsg return a string message to throw\n */\nfunction invariant(expr: unknown, createMsg: () => string): void {\n    if (!expr) {\n        throw new TypeError(createMsg());\n    }\n}\n\n/**\n * assert url is an URL object\n *\n * @param url\n */\nexport function assertURL(url: URL): void {\n    invariant(url instanceof URL, () => `Url must be an URL object. Received ${ JSON.stringify(url) }`);\n}","/* eslint-disable @typescript-eslint/no-explicit-any */\nimport { Err, Ok } from 'happy-rusty';\nimport { assertURL } from './assertions.ts';\nimport type { FetchInit, FetchResponse, FetchTask } from './defines.ts';\n\n/**\n * Return `FetchTask<string>`.\n * @param url\n * @param init\n */\nexport function fetchT(url: string | URL, init: FetchInit & {\n    abortable: true;\n    responseType: 'text';\n}): FetchTask<string>;\n/**\n * Return `FetchTask<ArrayBuffer>`.\n * @param url\n * @param init\n */\nexport function fetchT(url: string | URL, init: FetchInit & {\n    abortable: true;\n    responseType: 'arraybuffer';\n}): FetchTask<ArrayBuffer>;\n/**\n * Return `FetchTask<Blob>`.\n * @param url\n * @param init\n */\nexport function fetchT(url: string | URL, init: FetchInit & {\n    abortable: true;\n    responseType: 'blob';\n}): FetchTask<Blob>;\n/**\n * Return `FetchTask<T>`.\n */\nexport function fetchT<T>(url: string | URL, init: FetchInit & {\n    abortable: true;\n    responseType: 'json';\n}): FetchTask<T>;\n/**\n * Return `FetchResponse<string>`.\n * @param url\n * @param init\n */\nexport function fetchT(url: string | URL, init: FetchInit & {\n    responseType: 'text';\n}): FetchResponse<string>;\n/**\n * Return `FetchResponse<ArrayBuffer>`.\n * @param url\n * @param init\n */\nexport function fetchT(url: string | URL, init: FetchInit & {\n    responseType: 'arraybuffer';\n}): FetchResponse<ArrayBuffer>;\n/**\n * Return `FetchResponse<Blob>`.\n * @param url\n * @param init\n */\nexport function fetchT(url: string | URL, init: FetchInit & {\n    responseType: 'blob';\n}): FetchResponse<Blob>;\n/**\n * Return `FetchResponse<T>`.\n * @param url\n * @param init\n */\nexport function fetchT<T>(url: string | URL, init: FetchInit & {\n    responseType: 'json';\n}): FetchResponse<T>;\n/**\n * Return `FetchTask<Response>`.\n * @param url\n * @param init\n */\nexport function fetchT(url: string | URL, init: FetchInit & {\n    abortable: true;\n}): FetchTask<Response>;\n/**\n * Return `FetchResponse<Response>`.\n * @param url\n * @param init\n */\nexport function fetchT(url: string | URL, init: FetchInit & {\n    abortable: false;\n}): FetchResponse<Response>;\n/**\n * Return `FetchTask<T>` or `FetchResponse<T>`.\n * @param url\n * @param init\n */\nexport function fetchT<T = any>(url: string | URL, init: FetchInit): FetchTask<T> | FetchResponse<T>;\n/**\n * Return `FetchResponse<Response>`.\n * @param url\n * @param init\n */\nexport function fetchT(url: string | URL, init?: RequestInit): FetchResponse<Response>;\n/**\n * Request the url and return the corresponding type based on the responseType.\n * @param url url to fetch\n * @param init fetch init\n * @returns {FetchTask<T> | FetchResponse<T>} an abort able fetch task or just response\n */\nexport function fetchT<T = any>(url: string | URL, init?: FetchInit): FetchTask<T> | FetchResponse<T> {\n    if (typeof url !== 'string') {\n        assertURL(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            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":";;AAKA,SAAS,SAAA,CAAU,MAAe,SAA+B,EAAA;AAC7D,EAAA,IAAI,CAAC,IAAM,EAAA;AACP,IAAM,MAAA,IAAI,SAAU,CAAA,SAAA,EAAW,CAAA,CAAA;AAAA,GACnC;AACJ,CAAA;AAOO,SAAS,UAAU,GAAgB,EAAA;AACtC,EAAU,SAAA,CAAA,GAAA,YAAe,KAAK,MAAM,CAAA,oCAAA,EAAwC,KAAK,SAAU,CAAA,GAAG,CAAE,CAAE,CAAA,CAAA,CAAA;AACtG;;ACuFgB,SAAA,MAAA,CAAgB,KAAmB,IAAmD,EAAA;AAClG,EAAI,IAAA,OAAO,QAAQ,QAAU,EAAA;AACzB,IAAA,SAAA,CAAU,GAAG,CAAA,CAAA;AAAA,GACjB;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,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/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;;;;"}

package/dist/types.d.ts

@@ -1,133 +1,168 @@
 import { AsyncResult } from 'happy-rusty';
 
 /**
- * Response generic type.
+ * Represents the response of a fetch operation, encapsulating the result data or any error that occurred.
+ *
+ * @typeParam T - The type of the data expected in the response.
  */
 type FetchResponse<T> = AsyncResult<T, any>;
 /**
- * Return type of fetchT when abortable.
+ * Defines the structure and behavior of a fetch task, including the ability to abort the task and check its status.
+ *
+ * @typeParam T - The type of the data expected in the response.
  */
 interface FetchTask<T> {
     /**
-     * Aborts the request.
-     * @param reason The reason for aborting the request.
+     * Aborts the fetch task, optionally with a reason for the abortion.
+     *
+     * @param reason - An optional parameter to indicate why the task was aborted.
      */
     abort(reason?: any): void;
     /**
-     * Returns true if inner AbortSignal's AbortController has signaled to abort, and false otherwise.
+     * Indicates whether the fetch task has been aborted.
      */
     aborted: boolean;
     /**
-     * The response of the request.
+     * The response of the fetch task, represented as an `AsyncResult`.
      */
     response: FetchResponse<T>;
 }
 /**
- * Parameters for fetchT.
+ * Extends the standard `RequestInit` interface from the Fetch API to include additional custom options.
  */
 interface FetchInit extends RequestInit {
     /**
-     * true well return abort method.
+     * Indicates whether the fetch request should be abortable.
      */
     abortable?: boolean;
     /**
-     * The response type of the request.
+     * Specifies the expected response type of the fetch request.
      */
     responseType?: 'text' | 'arraybuffer' | 'blob' | 'json';
 }
 
 /**
- * Return `FetchTask<string>`.
- * @param url
- * @param init
+ * Fetches a resource from the network as a text string and returns a `FetchTask` representing the operation.
+ *
+ * @typeParam T - The expected type of the response data.
+ * @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, including custom `FetchInit` properties.
+ * @returns A `FetchTask` representing the operation with a `string` response.
  */
 declare function fetchT(url: string | URL, init: FetchInit & {
     abortable: true;
     responseType: 'text';
 }): FetchTask<string>;
 /**
- * Return `FetchTask<ArrayBuffer>`.
- * @param url
- * @param init
+ * Fetches a resource from the network as an ArrayBuffer and returns a `FetchTask` representing the operation.
+ *
+ * @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, including custom `FetchInit` properties.
+ * @returns A `FetchTask` representing the operation with an `ArrayBuffer` response.
  */
 declare function fetchT(url: string | URL, init: FetchInit & {
     abortable: true;
     responseType: 'arraybuffer';
 }): FetchTask<ArrayBuffer>;
 /**
- * Return `FetchTask<Blob>`.
- * @param url
- * @param init
+ * Fetches a resource from the network as a Blob and returns a `FetchTask` representing the operation.
+ *
+ * @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, including custom `FetchInit` properties.
+ * @returns A `FetchTask` representing the operation with a `Blob` response.
  */
 declare function fetchT(url: string | URL, init: FetchInit & {
     abortable: true;
     responseType: 'blob';
 }): FetchTask<Blob>;
 /**
- * Return `FetchTask<T>`.
+ * Fetches a resource from the network and parses it as JSON, returning a `FetchTask` representing the operation.
+ *
+ * @typeParam T - The expected type of the parsed JSON data.
+ * @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, including custom `FetchInit` properties.
+ * @returns A `FetchTask` representing the operation with a response parsed as JSON.
  */
 declare function fetchT<T>(url: string | URL, init: FetchInit & {
     abortable: true;
     responseType: 'json';
 }): FetchTask<T>;
 /**
- * Return `FetchResponse<string>`.
- * @param url
- * @param init
+ * Fetches a resource from the network as a text string and returns a `FetchResponse` representing the operation.
+ *
+ * @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, specifying the response type as 'text'.
+ * @returns A `FetchResponse` representing the operation with a `string` response.
  */
 declare function fetchT(url: string | URL, init: FetchInit & {
     responseType: 'text';
 }): FetchResponse<string>;
 /**
- * Return `FetchResponse<ArrayBuffer>`.
- * @param url
- * @param init
+ * Fetches a resource from the network as an ArrayBuffer and returns a `FetchResponse` representing the operation.
+ *
+ * @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, specifying the response type as 'arraybuffer'.
+ * @returns A `FetchResponse` representing the operation with an `ArrayBuffer` response.
  */
 declare function fetchT(url: string | URL, init: FetchInit & {
     responseType: 'arraybuffer';
 }): FetchResponse<ArrayBuffer>;
 /**
- * Return `FetchResponse<Blob>`.
- * @param url
- * @param init
+ * Fetches a resource from the network as a Blob and returns a `FetchResponse` representing the operation.
+ *
+ * @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, specifying the response type as 'blob'.
+ * @returns A `FetchResponse` representing the operation with a `Blob` response.
  */
 declare function fetchT(url: string | URL, init: FetchInit & {
     responseType: 'blob';
 }): FetchResponse<Blob>;
 /**
- * Return `FetchResponse<T>`.
- * @param url
- * @param init
+ * Fetches a resource from the network and parses it as JSON, returning a `FetchResponse` representing the operation.
+ *
+ * @typeParam T - The expected type of the parsed JSON data.
+ * @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, specifying the response type as 'json'.
+ * @returns A `FetchResponse` representing the operation with a response parsed as JSON.
  */
 declare function fetchT<T>(url: string | URL, init: FetchInit & {
     responseType: 'json';
 }): FetchResponse<T>;
 /**
- * Return `FetchTask<Response>`.
- * @param url
- * @param init
+ * Fetches a resource from the network and returns a `FetchTask` 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 be abortable.
+ * @returns A `FetchTask` representing the operation with a generic `Response`.
  */
 declare function fetchT(url: string | URL, init: FetchInit & {
     abortable: true;
 }): FetchTask<Response>;
 /**
- * Return `FetchResponse<Response>`.
- * @param url
- * @param init
+ * 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 & {
     abortable: false;
 }): FetchResponse<Response>;
 /**
- * Return `FetchTask<T>` or `FetchResponse<T>`.
- * @param url
- * @param init
+ * Fetches a resource from the network and returns a `FetchResponse` or `FetchTask` based on the provided options.
+ *
+ * @typeParam T - The expected type of the response data when not using a specific `responseType`.
+ * @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, including custom `FetchInit` properties.
+ * @returns A `FetchResponse` or `FetchTask` depending on the `abortable` option in `init`.
  */
-declare function fetchT<T = any>(url: string | URL, init: FetchInit): FetchTask<T> | FetchResponse<T>;
+declare function fetchT<T>(url: string | URL, init: FetchInit): FetchTask<T> | FetchResponse<T>;
 /**
- * Return `FetchResponse<Response>`.
- * @param url
- * @param init
+ * Fetches a resource from the network and returns a `FetchResponse` representing the operation.
+ *
+ * @param url - The resource to fetch. Can be a URL object or a string representing a URL.
+ * @param init - Standard `RequestInit` options for the fetch operation.
+ * @returns A `FetchResponse` representing the operation with a `Response` object.
  */
 declare function fetchT(url: string | URL, init?: RequestInit): FetchResponse<Response>;
 

package/docs/functions/fetchT.md

@@ -0,0 +1,325 @@
+[**@happy-ts/fetch-t**](../index.md) • **Docs**
+
+***
+
+[@happy-ts/fetch-t](../index.md) / fetchT
+
+# Function: fetchT()
+
+## fetchT(url, init)
+
+```ts
+function fetchT(url, init): FetchTask<string>
+```
+
+Fetches a resource from the network as a text string and returns a `FetchTask` representing the operation.
+
+### 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) & \{ `abortable`: `true`; `responseType`: `"text"`; \} | Additional options for the fetch operation, including custom `FetchInit` properties. |
+
+### Returns
+
+[`FetchTask`](../interfaces/FetchTask.md)\<`string`\>
+
+A `FetchTask` representing the operation with a `string` response.
+
+### Source
+
+[src/fetch/fetch.ts:14](https://github.com/JiangJie/fetch-t/blob/5ca54f90db4fac871c3148a812ceaa65b2b2c097/src/fetch/fetch.ts#L14)
+
+## fetchT(url, init)
+
+```ts
+function fetchT(url, init): FetchTask<ArrayBuffer>
+```
+
+Fetches a resource from the network as an ArrayBuffer and returns a `FetchTask` representing the operation.
+
+### 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) & \{ `abortable`: `true`; `responseType`: `"arraybuffer"`; \} | Additional options for the fetch operation, including custom `FetchInit` properties. |
+
+### Returns
+
+[`FetchTask`](../interfaces/FetchTask.md)\<`ArrayBuffer`\>
+
+A `FetchTask` representing the operation with an `ArrayBuffer` response.
+
+### Source
+
+[src/fetch/fetch.ts:26](https://github.com/JiangJie/fetch-t/blob/5ca54f90db4fac871c3148a812ceaa65b2b2c097/src/fetch/fetch.ts#L26)
+
+## fetchT(url, init)
+
+```ts
+function fetchT(url, init): FetchTask<Blob>
+```
+
+Fetches a resource from the network as a Blob and returns a `FetchTask` representing the operation.
+
+### 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) & \{ `abortable`: `true`; `responseType`: `"blob"`; \} | Additional options for the fetch operation, including custom `FetchInit` properties. |
+
+### Returns
+
+[`FetchTask`](../interfaces/FetchTask.md)\<`Blob`\>
+
+A `FetchTask` representing the operation with a `Blob` response.
+
+### Source
+
+[src/fetch/fetch.ts:38](https://github.com/JiangJie/fetch-t/blob/5ca54f90db4fac871c3148a812ceaa65b2b2c097/src/fetch/fetch.ts#L38)
+
+## fetchT(url, init)
+
+```ts
+function fetchT<T>(url, init): FetchTask<T>
+```
+
+Fetches a resource from the network and parses it as JSON, returning a `FetchTask` representing the operation.
+
+### Type parameters
+
+| Type parameter | Description |
+| :------ | :------ |
+| `T` | The expected type of the parsed JSON data. |
+
+### 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) & \{ `abortable`: `true`; `responseType`: `"json"`; \} | Additional options for the fetch operation, including custom `FetchInit` properties. |
+
+### Returns
+
+[`FetchTask`](../interfaces/FetchTask.md)\<`T`\>
+
+A `FetchTask` representing the operation with a response parsed as JSON.
+
+### Source
+
+[src/fetch/fetch.ts:51](https://github.com/JiangJie/fetch-t/blob/5ca54f90db4fac871c3148a812ceaa65b2b2c097/src/fetch/fetch.ts#L51)
+
+## fetchT(url, init)
+
+```ts
+function fetchT(url, init): FetchResponse<string>
+```
+
+Fetches a resource from the network as a text string and returns a `FetchResponse` representing the operation.
+
+### 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) & \{ `responseType`: `"text"`; \} | Additional options for the fetch operation, specifying the response type as 'text'. |
+
+### Returns
+
+[`FetchResponse`](../type-aliases/FetchResponse.md)\<`string`\>
+
+A `FetchResponse` representing the operation with a `string` response.
+
+### Source
+
+[src/fetch/fetch.ts:63](https://github.com/JiangJie/fetch-t/blob/5ca54f90db4fac871c3148a812ceaa65b2b2c097/src/fetch/fetch.ts#L63)
+
+## fetchT(url, init)
+
+```ts
+function fetchT(url, init): FetchResponse<ArrayBuffer>
+```
+
+Fetches a resource from the network as an ArrayBuffer and returns a `FetchResponse` representing the operation.
+
+### 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) & \{ `responseType`: `"arraybuffer"`; \} | Additional options for the fetch operation, specifying the response type as 'arraybuffer'. |
+
+### Returns
+
+[`FetchResponse`](../type-aliases/FetchResponse.md)\<`ArrayBuffer`\>
+
+A `FetchResponse` representing the operation with an `ArrayBuffer` response.
+
+### Source
+
+[src/fetch/fetch.ts:74](https://github.com/JiangJie/fetch-t/blob/5ca54f90db4fac871c3148a812ceaa65b2b2c097/src/fetch/fetch.ts#L74)
+
+## fetchT(url, init)
+
+```ts
+function fetchT(url, init): FetchResponse<Blob>
+```
+
+Fetches a resource from the network as a Blob and returns a `FetchResponse` representing the operation.
+
+### 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) & \{ `responseType`: `"blob"`; \} | Additional options for the fetch operation, specifying the response type as 'blob'. |
+
+### Returns
+
+[`FetchResponse`](../type-aliases/FetchResponse.md)\<`Blob`\>
+
+A `FetchResponse` representing the operation with a `Blob` response.
+
+### Source
+
+[src/fetch/fetch.ts:85](https://github.com/JiangJie/fetch-t/blob/5ca54f90db4fac871c3148a812ceaa65b2b2c097/src/fetch/fetch.ts#L85)
+
+## fetchT(url, init)
+
+```ts
+function fetchT<T>(url, init): FetchResponse<T>
+```
+
+Fetches a resource from the network and parses it as JSON, returning a `FetchResponse` representing the operation.
+
+### Type parameters
+
+| Type parameter | Description |
+| :------ | :------ |
+| `T` | The expected type of the parsed JSON data. |
+
+### 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) & \{ `responseType`: `"json"`; \} | Additional options for the fetch operation, specifying the response type as 'json'. |
+
+### Returns
+
+[`FetchResponse`](../type-aliases/FetchResponse.md)\<`T`\>
+
+A `FetchResponse` representing the operation with a response parsed as JSON.
+
+### Source
+
+[src/fetch/fetch.ts:97](https://github.com/JiangJie/fetch-t/blob/5ca54f90db4fac871c3148a812ceaa65b2b2c097/src/fetch/fetch.ts#L97)
+
+## fetchT(url, init)
+
+```ts
+function fetchT(url, init): FetchTask<Response>
+```
+
+Fetches a resource from the network and returns a `FetchTask` 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) & \{ `abortable`: `true`; \} | Additional options for the fetch operation, indicating that the operation should be abortable. |
+
+### Returns
+
+[`FetchTask`](../interfaces/FetchTask.md)\<`Response`\>
+
+A `FetchTask` representing the operation with a generic `Response`.
+
+### Source
+
+[src/fetch/fetch.ts:108](https://github.com/JiangJie/fetch-t/blob/5ca54f90db4fac871c3148a812ceaa65b2b2c097/src/fetch/fetch.ts#L108)
+
+## 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) & \{ `abortable`: `false`; \} | Additional options for the fetch operation, indicating that the operation should not be abortable. |
+
+### Returns
+
+[`FetchResponse`](../type-aliases/FetchResponse.md)\<`Response`\>
+
+A `FetchResponse` representing the operation with a generic `Response`.
+
+### Source
+
+[src/fetch/fetch.ts:119](https://github.com/JiangJie/fetch-t/blob/5ca54f90db4fac871c3148a812ceaa65b2b2c097/src/fetch/fetch.ts#L119)
+
+## fetchT(url, init)
+
+```ts
+function fetchT<T>(url, init): FetchTask<T> | FetchResponse<T>
+```
+
+Fetches a resource from the network and returns a `FetchResponse` or `FetchTask` based on the provided options.
+
+### Type parameters
+
+| Type parameter | Description |
+| :------ | :------ |
+| `T` | The expected type of the response data when not using a specific `responseType`. |
+
+### 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) | Additional options for the fetch operation, including custom `FetchInit` properties. |
+
+### Returns
+
+[`FetchTask`](../interfaces/FetchTask.md)\<`T`\> \| [`FetchResponse`](../type-aliases/FetchResponse.md)\<`T`\>
+
+A `FetchResponse` or `FetchTask` depending on the `abortable` option in `init`.
+
+### Source
+
+[src/fetch/fetch.ts:131](https://github.com/JiangJie/fetch-t/blob/5ca54f90db4fac871c3148a812ceaa65b2b2c097/src/fetch/fetch.ts#L131)
+
+## fetchT(url, init)
+
+```ts
+function fetchT(url, init?): FetchResponse<Response>
+```
+
+Fetches a resource from the network and returns a `FetchResponse` representing the operation.
+
+### Parameters
+
+| Parameter | Type | Description |
+| :------ | :------ | :------ |
+| `url` | `string` \| `URL` | The resource to fetch. Can be a URL object or a string representing a URL. |
+| `init`? | `RequestInit` | Standard `RequestInit` options for the fetch operation. |
+
+### Returns
+
+[`FetchResponse`](../type-aliases/FetchResponse.md)\<`Response`\>
+
+A `FetchResponse` representing the operation with a `Response` object.
+
+### Source
+
+[src/fetch/fetch.ts:140](https://github.com/JiangJie/fetch-t/blob/5ca54f90db4fac871c3148a812ceaa65b2b2c097/src/fetch/fetch.ts#L140)

package/docs/index.md

@@ -0,0 +1,24 @@
+**@happy-ts/fetch-t** • **Docs**
+
+***
+
+# @happy-ts/fetch-t
+
+## Interfaces
+
+| Interface | Description |
+| :------ | :------ |
+| [FetchInit](interfaces/FetchInit.md) | Extends the standard `RequestInit` interface from the Fetch API to include additional custom options. |
+| [FetchTask](interfaces/FetchTask.md) | Defines the structure and behavior of a fetch task, including the ability to abort the task and check its status. |
+
+## Type Aliases
+
+| Type alias | Description |
+| :------ | :------ |
+| [FetchResponse](type-aliases/FetchResponse.md) | Represents the response of a fetch operation, encapsulating the result data or any error that occurred. |
+
+## Functions
+
+| Function | Description |
+| :------ | :------ |
+| [fetchT](functions/fetchT.md) | Fetches a resource from the network as a text string and returns a `FetchTask` representing the operation. |

package/docs/interfaces/FetchInit.md

@@ -0,0 +1,34 @@
+[**@happy-ts/fetch-t**](../index.md) • **Docs**
+
+***
+
+[@happy-ts/fetch-t](../index.md) / FetchInit
+
+# Interface: FetchInit
+
+Extends the standard `RequestInit` interface from the Fetch API to include additional custom options.
+
+## Extends
+
+- `RequestInit`
+
+## Properties
+
+| Property | Type | Description | Inherited from |
+| :------ | :------ | :------ | :------ |
+| `abortable?` | `boolean` | Indicates whether the fetch request should be abortable. | - |
+| `body?` | `null` \| `BodyInit` | A BodyInit object or null to set request's body. | `RequestInit.body` |
+| `cache?` | `RequestCache` | A string indicating how the request will interact with the browser's cache to set request's cache. | `RequestInit.cache` |
+| `credentials?` | `RequestCredentials` | A string indicating whether credentials will be sent with the request always, never, or only when sent to a same-origin URL. Sets request's credentials. | `RequestInit.credentials` |
+| `headers?` | `HeadersInit` | A Headers object, an object literal, or an array of two-item arrays to set request's headers. | `RequestInit.headers` |
+| `integrity?` | `string` | A cryptographic hash of the resource to be fetched by request. Sets request's integrity. | `RequestInit.integrity` |
+| `keepalive?` | `boolean` | A boolean to set request's keepalive. | `RequestInit.keepalive` |
+| `method?` | `string` | A string to set request's method. | `RequestInit.method` |
+| `mode?` | `RequestMode` | A string to indicate whether the request will use CORS, or will be restricted to same-origin URLs. Sets request's mode. | `RequestInit.mode` |
+| `priority?` | `RequestPriority` | - | `RequestInit.priority` |
+| `redirect?` | `RequestRedirect` | A string indicating whether request follows redirects, results in an error upon encountering a redirect, or returns the redirect (in an opaque fashion). Sets request's redirect. | `RequestInit.redirect` |
+| `referrer?` | `string` | A string whose value is a same-origin URL, "about:client", or the empty string, to set request's referrer. | `RequestInit.referrer` |
+| `referrerPolicy?` | `ReferrerPolicy` | A referrer policy to set request's referrerPolicy. | `RequestInit.referrerPolicy` |
+| `responseType?` | `"text"` \| `"arraybuffer"` \| `"blob"` \| `"json"` | Specifies the expected response type of the fetch request. | - |
+| `signal?` | `null` \| `AbortSignal` | An AbortSignal to set request's signal. | `RequestInit.signal` |
+| `window?` | `null` | Can only be null. Used to disassociate request from any Window. | `RequestInit.window` |

package/docs/interfaces/FetchTask.md

@@ -0,0 +1,46 @@
+[**@happy-ts/fetch-t**](../index.md) • **Docs**
+
+***
+
+[@happy-ts/fetch-t](../index.md) / FetchTask
+
+# Interface: FetchTask\<T\>
+
+Defines the structure and behavior of a fetch task, including the ability to abort the task and check its status.
+
+## Type parameters
+
+| Type parameter | Description |
+| :------ | :------ |
+| `T` | The type of the data expected in the response. |
+
+## Properties
+
+| Property | Type | Description |
+| :------ | :------ | :------ |
+| `aborted` | `boolean` | Indicates whether the fetch task has been aborted. |
+| `response` | [`FetchResponse`](../type-aliases/FetchResponse.md)\<`T`\> | The response of the fetch task, represented as an `AsyncResult`. |
+
+## Methods
+
+### abort()
+
+```ts
+abort(reason?): void
+```
+
+Aborts the fetch task, optionally with a reason for the abortion.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| :------ | :------ | :------ |
+| `reason`? | `any` | An optional parameter to indicate why the task was aborted. |
+
+#### Returns
+
+`void`
+
+#### Source
+
+[src/fetch/defines.ts:22](https://github.com/JiangJie/fetch-t/blob/5ca54f90db4fac871c3148a812ceaa65b2b2c097/src/fetch/defines.ts#L22)

package/docs/type-aliases/FetchResponse.md

@@ -0,0 +1,23 @@
+[**@happy-ts/fetch-t**](../index.md) • **Docs**
+
+***
+
+[@happy-ts/fetch-t](../index.md) / FetchResponse
+
+# Type alias: FetchResponse\<T\>
+
+```ts
+type FetchResponse<T>: AsyncResult<T, any>;
+```
+
+Represents the response of a fetch operation, encapsulating the result data or any error that occurred.
+
+## Type parameters
+
+| Type parameter | Description |
+| :------ | :------ |
+| `T` | The type of the data expected in the response. |
+
+## Source
+
+[src/fetch/defines.ts:9](https://github.com/JiangJie/fetch-t/blob/5ca54f90db4fac871c3148a812ceaa65b2b2c097/src/fetch/defines.ts#L9)

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.8",
+  "version": "1.0.9",
   "type": "module",
   "source": "src/mod.ts",
   "main": "dist/main.cjs",
@@ -14,6 +14,7 @@
     "README.md",
     "README.cn.md",
     "package.json",
+    "docs",
     "src",
     "dist"
   ],
@@ -21,9 +22,14 @@
   "scripts": {
     "check": "pnpm exec tsc --noEmit",
     "lint": "pnpm exec eslint src/",
-    "prebuild": "pnpm exec rimraf dist && pnpm run check && pnpm run lint",
+    "prebuild": "pnpm dlx rimraf dist && pnpm run check && pnpm run lint",
     "build": "pnpm exec rollup --config rollup.config.mjs",
-    "test": "bun test --coverage",
+    "pretest": "pnpm dlx rimraf coverage",
+    "test": "deno test -A --coverage && deno coverage coverage && deno coverage coverage --lcov --output=coverage/cov_profile.lcov",
+    "pretest:html": "pnpm run pretest",
+    "test:html": "deno test -A --coverage && deno coverage coverage && deno coverage coverage --html",
+    "predocs": "pnpm dlx rimraf docs",
+    "docs": "pnpm exec typedoc",
     "prepublishOnly": "pnpm run build"
   },
   "repository": {
@@ -37,18 +43,19 @@
     "responseType"
   ],
   "devDependencies": {
-    "@jest/globals": "^29.7.0",
-    "@typescript-eslint/eslint-plugin": "^7.9.0",
-    "@typescript-eslint/parser": "^7.9.0",
+    "@typescript-eslint/eslint-plugin": "^7.13.0",
+    "@typescript-eslint/parser": "^7.13.0",
     "eslint": "^8.57.0",
-    "rimraf": "^5.0.7",
-    "rollup": "^4.17.2",
-    "rollup-plugin-dts": "^6.1.0",
+    "rollup": "^4.18.0",
+    "rollup-plugin-dts": "^6.1.1",
     "rollup-plugin-esbuild": "^6.1.1",
+    "typedoc": "^0.25.13",
+    "typedoc-plugin-markdown": "^4.0.3",
     "typescript": "^5.4.5"
   },
   "dependencies": {
-    "happy-rusty": "^1.0.9"
+    "happy-rusty": "^1.1.0",
+    "tiny-invariant": "^1.3.3"
   },
-  "packageManager": "pnpm@9.1.1+sha512.14e915759c11f77eac07faba4d019c193ec8637229e62ec99eefb7cf3c3b75c64447882b7c485142451ee3a6b408059cdfb7b7fa0341b975f12d0f7629c71195"
+  "packageManager": "pnpm@9.3.0"
 }

package/src/fetch/defines.ts

@@ -2,39 +2,47 @@
 import type { AsyncResult } from 'happy-rusty';
 
 /**
- * Response generic type.
+ * Represents the response of a fetch operation, encapsulating the result data or any error that occurred.
+ *
+ * @typeParam T - The type of the data expected in the response.
  */
 export type FetchResponse<T> = AsyncResult<T, any>;
 
 /**
- * Return type of fetchT when abortable.
+ * Defines the structure and behavior of a fetch task, including the ability to abort the task and check its status.
+ *
+ * @typeParam T - The type of the data expected in the response.
  */
 export interface FetchTask<T> {
     /**
-     * Aborts the request.
-     * @param reason The reason for aborting the request.
+     * Aborts the fetch task, optionally with a reason for the abortion.
+     *
+     * @param reason - An optional parameter to indicate why the task was aborted.
      */
     abort(reason?: any): void;
+
     /**
-     * Returns true if inner AbortSignal's AbortController has signaled to abort, and false otherwise.
+     * Indicates whether the fetch task has been aborted.
      */
     aborted: boolean;
+
     /**
-     * The response of the request.
+     * The response of the fetch task, represented as an `AsyncResult`.
      */
     response: FetchResponse<T>;
 }
 
 /**
- * Parameters for fetchT.
+ * Extends the standard `RequestInit` interface from the Fetch API to include additional custom options.
  */
 export interface FetchInit extends RequestInit {
     /**
-     * true well return abort method.
+     * Indicates whether the fetch request should be abortable.
      */
     abortable?: boolean;
+
     /**
-     * The response type of the request.
+     * Specifies the expected response type of the fetch request.
      */
     responseType?: 'text' | 'arraybuffer' | 'blob' | 'json';
 }

package/src/fetch/fetch.ts

@@ -1,111 +1,156 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
 import { Err, Ok } from 'happy-rusty';
-import { assertURL } from './assertions.ts';
+import invariant from 'tiny-invariant';
 import type { FetchInit, FetchResponse, FetchTask } from './defines.ts';
 
 /**
- * Return `FetchTask<string>`.
- * @param url
- * @param init
+ * Fetches a resource from the network as a text string and returns a `FetchTask` representing the operation.
+ *
+ * @typeParam T - The expected type of the response data.
+ * @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, including custom `FetchInit` properties.
+ * @returns A `FetchTask` representing the operation with a `string` response.
  */
 export function fetchT(url: string | URL, init: FetchInit & {
     abortable: true;
     responseType: 'text';
 }): FetchTask<string>;
+
 /**
- * Return `FetchTask<ArrayBuffer>`.
- * @param url
- * @param init
+ * Fetches a resource from the network as an ArrayBuffer and returns a `FetchTask` representing the operation.
+ *
+ * @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, including custom `FetchInit` properties.
+ * @returns A `FetchTask` representing the operation with an `ArrayBuffer` response.
  */
 export function fetchT(url: string | URL, init: FetchInit & {
     abortable: true;
     responseType: 'arraybuffer';
 }): FetchTask<ArrayBuffer>;
+
 /**
- * Return `FetchTask<Blob>`.
- * @param url
- * @param init
+ * Fetches a resource from the network as a Blob and returns a `FetchTask` representing the operation.
+ *
+ * @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, including custom `FetchInit` properties.
+ * @returns A `FetchTask` representing the operation with a `Blob` response.
  */
 export function fetchT(url: string | URL, init: FetchInit & {
     abortable: true;
     responseType: 'blob';
 }): FetchTask<Blob>;
+
 /**
- * Return `FetchTask<T>`.
+ * Fetches a resource from the network and parses it as JSON, returning a `FetchTask` representing the operation.
+ *
+ * @typeParam T - The expected type of the parsed JSON data.
+ * @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, including custom `FetchInit` properties.
+ * @returns A `FetchTask` representing the operation with a response parsed as JSON.
  */
 export function fetchT<T>(url: string | URL, init: FetchInit & {
     abortable: true;
     responseType: 'json';
 }): FetchTask<T>;
+
 /**
- * Return `FetchResponse<string>`.
- * @param url
- * @param init
+ * Fetches a resource from the network as a text string and returns a `FetchResponse` representing the operation.
+ *
+ * @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, specifying the response type as 'text'.
+ * @returns A `FetchResponse` representing the operation with a `string` response.
  */
 export function fetchT(url: string | URL, init: FetchInit & {
     responseType: 'text';
 }): FetchResponse<string>;
+
 /**
- * Return `FetchResponse<ArrayBuffer>`.
- * @param url
- * @param init
+ * Fetches a resource from the network as an ArrayBuffer and returns a `FetchResponse` representing the operation.
+ *
+ * @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, specifying the response type as 'arraybuffer'.
+ * @returns A `FetchResponse` representing the operation with an `ArrayBuffer` response.
  */
 export function fetchT(url: string | URL, init: FetchInit & {
     responseType: 'arraybuffer';
 }): FetchResponse<ArrayBuffer>;
+
 /**
- * Return `FetchResponse<Blob>`.
- * @param url
- * @param init
+ * Fetches a resource from the network as a Blob and returns a `FetchResponse` representing the operation.
+ *
+ * @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, specifying the response type as 'blob'.
+ * @returns A `FetchResponse` representing the operation with a `Blob` response.
  */
 export function fetchT(url: string | URL, init: FetchInit & {
     responseType: 'blob';
 }): FetchResponse<Blob>;
+
 /**
- * Return `FetchResponse<T>`.
- * @param url
- * @param init
+ * Fetches a resource from the network and parses it as JSON, returning a `FetchResponse` representing the operation.
+ *
+ * @typeParam T - The expected type of the parsed JSON data.
+ * @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, specifying the response type as 'json'.
+ * @returns A `FetchResponse` representing the operation with a response parsed as JSON.
  */
 export function fetchT<T>(url: string | URL, init: FetchInit & {
     responseType: 'json';
 }): FetchResponse<T>;
+
 /**
- * Return `FetchTask<Response>`.
- * @param url
- * @param init
+ * Fetches a resource from the network and returns a `FetchTask` 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 be abortable.
+ * @returns A `FetchTask` representing the operation with a generic `Response`.
  */
 export function fetchT(url: string | URL, init: FetchInit & {
     abortable: true;
 }): FetchTask<Response>;
+
 /**
- * Return `FetchResponse<Response>`.
- * @param url
- * @param init
+ * 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 & {
     abortable: false;
 }): FetchResponse<Response>;
+
 /**
- * Return `FetchTask<T>` or `FetchResponse<T>`.
- * @param url
- * @param init
+ * Fetches a resource from the network and returns a `FetchResponse` or `FetchTask` based on the provided options.
+ *
+ * @typeParam T - The expected type of the response data when not using a specific `responseType`.
+ * @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, including custom `FetchInit` properties.
+ * @returns A `FetchResponse` or `FetchTask` depending on the `abortable` option in `init`.
  */
-export function fetchT<T = any>(url: string | URL, init: FetchInit): FetchTask<T> | FetchResponse<T>;
+export function fetchT<T>(url: string | URL, init: FetchInit): FetchTask<T> | FetchResponse<T>;
+
 /**
- * Return `FetchResponse<Response>`.
- * @param url
- * @param init
+ * Fetches a resource from the network and returns a `FetchResponse` representing the operation.
+ *
+ * @param url - The resource to fetch. Can be a URL object or a string representing a URL.
+ * @param init - Standard `RequestInit` options for the fetch operation.
+ * @returns A `FetchResponse` representing the operation with a `Response` object.
  */
 export function fetchT(url: string | URL, init?: RequestInit): FetchResponse<Response>;
+
 /**
- * Request the url and return the corresponding type based on the responseType.
- * @param url url to fetch
- * @param init fetch init
- * @returns {FetchTask<T> | FetchResponse<T>} an abort able fetch task or just response
+ * Fetches a resource from the network and returns either a `FetchTask` or `FetchResponse` based on the provided options.
+ *
+ * @typeParam T - The expected type of the response data when not using a specific `responseType`.
+ * @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, including custom `FetchInit` properties.
+ * @returns A `FetchTask` or `FetchResponse` depending on the provided options in `init`.
  */
-export function fetchT<T = any>(url: string | URL, init?: FetchInit): FetchTask<T> | FetchResponse<T> {
+export function fetchT<T>(url: string | URL, init?: FetchInit): FetchTask<T> | FetchResponse<T> {
+    // most cases
     if (typeof url !== 'string') {
-        assertURL(url);
+        invariant(url instanceof URL, () => `Url must be a string or URL object but received ${ url }.`);
     }
 
     // default not abort able
@@ -120,6 +165,7 @@ export function fetchT<T = any>(url: string | URL, init?: FetchInit): FetchTask<
 
     const response: FetchResponse<T> = fetch(url, rest).then(async (res): FetchResponse<T> => {
         if (!res.ok) {
+            await res.body?.cancel();
             return Err(new Error(`fetch status: ${ res.status }`));
         }
 

package/src/fetch/assertions.ts

@@ -1,19 +0,0 @@
-/**
- * assert function
- * @param expr
- * @param createMsg return a string message to throw
- */
-function invariant(expr: unknown, createMsg: () => string): void {
-    if (!expr) {
-        throw new TypeError(createMsg());
-    }
-}
-
-/**
- * assert url is an URL object
- *
- * @param url
- */
-export function assertURL(url: URL): void {
-    invariant(url instanceof URL, () => `Url must be an URL object. Received ${ JSON.stringify(url) }`);
-}