@happy-ts/fetch-t 1.3.3 → 1.4.0

package/package.json

@@ -1,35 +1,42 @@
 {
   "name": "@happy-ts/fetch-t",
-  "description": "Abortable fetch wrapper with the ability to specify the return type.",
+  "description": "Type-safe Fetch API wrapper with abortable requests, timeout support, progress tracking, and Rust-like Result error handling.",
   "author": "jiang115jie@gmail.com",
-  "license": "GPL-3.0",
-  "version": "1.3.3",
+  "license": "MIT",
+  "version": "1.4.0",
   "type": "module",
   "source": "src/mod.ts",
   "main": "dist/main.cjs",
   "module": "dist/main.mjs",
   "types": "dist/types.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/types.d.ts",
+      "import": "./dist/main.mjs",
+      "require": "./dist/main.cjs",
+      "default": "./dist/main.mjs"
+    },
+    "./package.json": "./package.json"
+  },
   "files": [
     "LICENSE",
     "README.md",
     "README.cn.md",
-    "package.json",
-    "docs",
-    "src",
+    "CHANGELOG.md",
     "dist"
   ],
   "sideEffects": false,
   "scripts": {
     "check": "pnpm exec tsc --noEmit",
     "lint": "pnpm exec eslint .",
-    "prebuild": "pnpm dlx rimraf dist && pnpm run check && pnpm run lint",
-    "build": "pnpm exec rollup --config rollup.config.mjs",
-    "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",
+    "prebuild": "pnpm run check && pnpm run lint",
+    "build": "pnpm exec vite build",
+    "test": "pnpm exec vitest run --coverage",
+    "test:watch": "pnpm exec vitest",
+    "test:ui": "pnpm exec vitest --ui",
     "predocs": "pnpm dlx rimraf docs",
     "docs": "pnpm exec typedoc",
+    "eg": "node examples/main.ts",
     "prepublishOnly": "pnpm run build"
   },
   "repository": {
@@ -40,21 +47,29 @@
     "fetch",
     "abort",
     "cancel",
-    "responseType"
+    "timeout",
+    "progress",
+    "streaming",
+    "type-safe",
+    "typescript",
+    "result",
+    "async"
   ],
   "devDependencies": {
-    "@eslint/js": "^9.39.1",
-    "eslint": "^9.39.1",
-    "rollup": "^4.53.3",
-    "rollup-plugin-dts": "^6.3.0",
-    "rollup-plugin-esbuild": "^6.2.1",
-    "typedoc": "^0.27.9",
-    "typedoc-plugin-markdown": "^4.4.2",
+    "@eslint/js": "^9.39.2",
+    "@stylistic/eslint-plugin": "^5.6.1",
+    "@vitest/coverage-v8": "^4.0.16",
+    "eslint": "^9.39.2",
+    "msw": "^2.12.4",
+    "typedoc": "^0.28.15",
     "typescript": "^5.9.3",
-    "typescript-eslint": "^8.48.0"
+    "typescript-eslint": "^8.50.0",
+    "vite": "^7.3.0",
+    "vite-plugin-dts": "^4.5.4",
+    "vitest": "^4.0.16"
   },
   "dependencies": {
-    "happy-rusty": "^1.5.0",
+    "happy-rusty": "^1.6.1",
     "tiny-invariant": "^1.3.3"
   }
 }

package/dist/types.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.d.ts","sources":["../src/fetch/constants.ts","../src/fetch/defines.ts","../src/fetch/fetch.ts"],"sourcesContent":["/**\n * Name of abort error;\n */\nexport const ABORT_ERROR = 'AbortError' as const;\n\n/**\n * Name of timeout error;\n */\nexport const TIMEOUT_ERROR = 'TimeoutError' as const;","/* eslint-disable @typescript-eslint/no-explicit-any */\nimport type { AsyncResult, IOResult } 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, E = any> = AsyncResult<T, E>;\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    readonly aborted: boolean;\n\n    /**\n     * The response of the fetch task, represented as an `AsyncResult`.\n     */\n    readonly response: FetchResponse<T>;\n}\n\n/**\n * Specifies the expected response type of the fetch request.\n */\nexport type FetchResponseType = 'text' | 'arraybuffer' | 'blob' | 'json';\n\n/**\n * Represents the progress of a fetch operation.\n */\nexport interface FetchProgress {\n    /**\n     * The total number of bytes to be received.\n     */\n    totalByteLength: number;\n\n    /**\n     * The number of bytes received so far.\n     */\n    completedByteLength: number;\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?: FetchResponseType;\n\n    /**\n     * Specifies the maximum time in milliseconds to wait for the fetch request to complete.\n     */\n    timeout?: number;\n\n    /**\n     * Specifies a function to be called when the fetch request makes progress.\n     * @param progressResult - The progress of the fetch request.\n     */\n    onProgress?: (progressResult: IOResult<FetchProgress>) => void;\n\n    /**\n     * Specifies a function to be called when the fetch request receives a chunk of data.\n     * @param chunk - The chunk of data received.\n     */\n    onChunk?: (chunk: Uint8Array) => void;\n}\n\n/**\n * Represents an error that occurred during a fetch operation when the response is not ok.\n */\nexport class FetchError extends Error {\n    /**\n     * The name of the error.\n     */\n    override name = 'FetchError';\n    /**\n     * The status code of the response.\n     */\n    status = 0;\n\n    constructor(message: string, status: number) {\n        super(message);\n        this.status = status;\n    }\n}","import { Err, Ok } from 'happy-rusty';\nimport invariant from 'tiny-invariant';\nimport { TIMEOUT_ERROR } from './constants.ts';\nimport { FetchError, 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, Error>;\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, Error>;\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, Error>;\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, Error>;\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` 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` representing the operation with a `Response` object.\n */\nexport function fetchT(url: string | URL, init?: FetchInit): 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        onProgress,\n        onChunk,\n        ...rest\n    } = init ?? {};\n\n    const shouldWaitTimeout = timeout != null;\n    let cancelTimer: (() => void) | 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        cancelTimer?.();\n\n        if (!res.ok) {\n            await res.body?.cancel();\n            return Err(new FetchError(res.statusText, res.status));\n        }\n\n        if (res.body) {\n            // should notify progress or data chunk?\n            const shouldNotifyProgress = typeof onProgress === 'function';\n            const shouldNotifyChunk = typeof onChunk === 'function';\n\n            if ((shouldNotifyProgress || shouldNotifyChunk)) {\n                // tee the original stream to two streams, one for notify progress, another for response\n                const [stream1, stream2] = res.body.tee();\n\n                const reader = stream1.getReader();\n                // may has no  content-length\n                let totalByteLength: number | null = null;\n                let completedByteLength = 0;\n\n                if (shouldNotifyProgress) {\n                    // try to get content-length\n                    // compatible with http/2\n                    const contentLength = res.headers.get('content-length') ?? res.headers.get('Content-Length');\n                    if (contentLength == null) {\n                        // response headers has no content-length\n                        onProgress(Err(new Error('No content-length in response headers.')));\n                    } else {\n                        totalByteLength = parseInt(contentLength, 10);\n                    }\n                }\n\n                reader.read().then(function notify({ done, value }) {\n                    if (done) {\n                        return;\n                    }\n\n                    // notify chunk\n                    if (shouldNotifyChunk) {\n                        onChunk(value);\n                    }\n\n                    // notify progress\n                    if (shouldNotifyProgress && totalByteLength != null) {\n                        completedByteLength += value.byteLength;\n                        onProgress(Ok({\n                            totalByteLength,\n                            completedByteLength,\n                        }));\n                    }\n\n\n                    // continue to read\n                    reader.read().then(notify);\n                });\n\n                // replace the original response with the new one\n                res = new Response(stream2, {\n                    headers: res.headers,\n                    status: res.status,\n                    statusText: res.statusText,\n                });\n            }\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        cancelTimer?.();\n\n        return Err(err);\n    });\n\n    if (shouldWaitTimeout) {\n        const timer = 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        cancelTimer = (): void => {\n            if (timer) {\n                clearTimeout(timer);\n            }\n\n            cancelTimer = null;\n        };\n    }\n\n    if (abortable) {\n        return {\n            // eslint-disable-next-line @typescript-eslint/no-explicit-any\n            abort(reason?: any): void {\n                cancelTimer?.();\n                controller.abort(reason);\n            },\n\n            get aborted(): boolean {\n                return controller.signal.aborted;\n            },\n\n            get response(): FetchResponse<T> {\n                return response;\n            },\n        };\n    } else {\n        return response;\n    }\n}"],"names":[],"mappings":";;AAAA;AACA;AACA;AACO,cAAA,WAAA;AACP;AACA;AACA;AACO,cAAA,aAAA;;ACNP;AACA;AACA;AACA;AACA;AACO,KAAA,aAAA,eAAA,WAAA;AACP;AACA;AACA;AACA;AACA;AACO,UAAA,SAAA;AACP;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,uBAAA,aAAA;AACA;AACA;AACA;AACA;AACO,KAAA,iBAAA;AACP;AACA;AACA;AACO,UAAA,aAAA;AACP;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,UAAA,SAAA,SAAA,WAAA;AACP;AACA;AACA;AACA;AACA;AACA;AACA;AACA,mBAAA,iBAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,kCAAA,QAAA,CAAA,aAAA;AACA;AACA;AACA;AACA;AACA,sBAAA,UAAA;AACA;AACA;AACA;AACA;AACO,cAAA,UAAA,SAAA,KAAA;AACP;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;ACpFA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,iBAAA,MAAA,eAAA,GAAA,QAAA,SAAA;AACP;AACA;AACA,IAAA,SAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,iBAAA,MAAA,eAAA,GAAA,QAAA,SAAA;AACP;AACA;AACA,IAAA,SAAA,CAAA,WAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,iBAAA,MAAA,eAAA,GAAA,QAAA,SAAA;AACP;AACA;AACA,IAAA,SAAA,CAAA,IAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,iBAAA,MAAA,kBAAA,GAAA,QAAA,SAAA;AACP;AACA;AACA,IAAA,SAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,iBAAA,MAAA,eAAA,GAAA,QAAA,SAAA;AACP;AACA,IAAA,aAAA,SAAA,KAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,iBAAA,MAAA,eAAA,GAAA,QAAA,SAAA;AACP;AACA,IAAA,aAAA,CAAA,WAAA,EAAA,KAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,iBAAA,MAAA,eAAA,GAAA,QAAA,SAAA;AACP;AACA,IAAA,aAAA,CAAA,IAAA,EAAA,KAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,iBAAA,MAAA,kBAAA,GAAA,QAAA,SAAA;AACP;AACA,IAAA,aAAA,IAAA,KAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,iBAAA,MAAA,eAAA,GAAA,QAAA,SAAA;AACP;AACA,IAAA,SAAA,CAAA,QAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,iBAAA,MAAA,eAAA,GAAA,SAAA,SAAA,GAAA,aAAA,CAAA,QAAA;;;;"}

package/docs/README.md

@@ -1,39 +0,0 @@
-**@happy-ts/fetch-t**
-
-***
-
-# @happy-ts/fetch-t
-
-## Classes
-
-| Class | Description |
-| ------ | ------ |
-| [FetchError](classes/FetchError.md) | Represents an error that occurred during a fetch operation when the response is not ok. |
-
-## Interfaces
-
-| Interface | Description |
-| ------ | ------ |
-| [FetchInit](interfaces/FetchInit.md) | Extends the standard `RequestInit` interface from the Fetch API to include additional custom options. |
-| [FetchProgress](interfaces/FetchProgress.md) | Represents the progress of a fetch operation. |
-| [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. |
-| [FetchResponseType](type-aliases/FetchResponseType.md) | Specifies the expected response type of the fetch request. |
-
-## 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 |
-| ------ | ------ |
-| [fetchT](functions/fetchT.md) | Fetches a resource from the network and returns either a `FetchTask` or `FetchResponse` based on the provided options. |

package/docs/classes/FetchError.md

@@ -1,49 +0,0 @@
-[**@happy-ts/fetch-t**](../README.md)
-
-***
-
-[@happy-ts/fetch-t](../README.md) / FetchError
-
-# Class: FetchError
-
-Defined in: [defines.ts:90](https://github.com/JiangJie/fetch-t/blob/bef789cb418392a07597af77b2942bea27482d3e/src/fetch/defines.ts#L90)
-
-Represents an error that occurred during a fetch operation when the response is not ok.
-
-## Extends
-
-- `Error`
-
-## Constructors
-
-### new FetchError()
-
-```ts
-new FetchError(message, status): FetchError
-```
-
-Defined in: [defines.ts:100](https://github.com/JiangJie/fetch-t/blob/bef789cb418392a07597af77b2942bea27482d3e/src/fetch/defines.ts#L100)
-
-#### Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `message` | `string` |
-| `status` | `number` |
-
-#### Returns
-
-[`FetchError`](FetchError.md)
-
-#### Overrides
-
-```ts
-Error.constructor
-```
-
-## Properties
-
-| Property | Type | Default value | Description | Overrides | Defined in |
-| ------ | ------ | ------ | ------ | ------ | ------ |
-| <a id="name"></a> `name` | `string` | `'FetchError'` | The name of the error. | `Error.name` | [defines.ts:94](https://github.com/JiangJie/fetch-t/blob/bef789cb418392a07597af77b2942bea27482d3e/src/fetch/defines.ts#L94) |
-| <a id="status-1"></a> `status` | `number` | `0` | The status code of the response. | - | [defines.ts:98](https://github.com/JiangJie/fetch-t/blob/bef789cb418392a07597af77b2942bea27482d3e/src/fetch/defines.ts#L98) |

package/docs/functions/fetchT.md

@@ -1,403 +0,0 @@
-[**@happy-ts/fetch-t**](../README.md)
-
-***
-
-[@happy-ts/fetch-t](../README.md) / fetchT
-
-# Function: fetchT()
-
-Fetches a resource from the network and returns either a `FetchTask` or `FetchResponse` based on the provided options.
-
-## 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.
-
-## Call Signature
-
-```ts
-function fetchT(url, init): FetchTask<string>
-```
-
-Defined in: [fetch.ts:14](https://github.com/JiangJie/fetch-t/blob/bef789cb418392a07597af77b2942bea27482d3e/src/fetch/fetch.ts#L14)
-
-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` or `FetchResponse` depending on the provided options in `init`.
-
-A `FetchTask` representing the operation with a `string` response.
-
-### 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.
-
-## Call Signature
-
-```ts
-function fetchT(url, init): FetchTask<ArrayBuffer>
-```
-
-Defined in: [fetch.ts:26](https://github.com/JiangJie/fetch-t/blob/bef789cb418392a07597af77b2942bea27482d3e/src/fetch/fetch.ts#L26)
-
-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` or `FetchResponse` depending on the provided options in `init`.
-
-A `FetchTask` representing the operation with an `ArrayBuffer` response.
-
-### 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.
-
-## Call Signature
-
-```ts
-function fetchT(url, init): FetchTask<Blob>
-```
-
-Defined in: [fetch.ts:38](https://github.com/JiangJie/fetch-t/blob/bef789cb418392a07597af77b2942bea27482d3e/src/fetch/fetch.ts#L38)
-
-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` or `FetchResponse` depending on the provided options in `init`.
-
-A `FetchTask` representing the operation with a `Blob` response.
-
-### 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.
-
-## Call Signature
-
-```ts
-function fetchT<T>(url, init): FetchTask<T>
-```
-
-Defined in: [fetch.ts:51](https://github.com/JiangJie/fetch-t/blob/bef789cb418392a07597af77b2942bea27482d3e/src/fetch/fetch.ts#L51)
-
-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` or `FetchResponse` depending on the provided options in `init`.
-
-A `FetchTask` representing the operation with a response parsed as JSON.
-
-### 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.
-
-## Call Signature
-
-```ts
-function fetchT(url, init): FetchResponse<string, Error>
-```
-
-Defined in: [fetch.ts:63](https://github.com/JiangJie/fetch-t/blob/bef789cb418392a07597af77b2942bea27482d3e/src/fetch/fetch.ts#L63)
-
-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`, `Error`\>
-
-A `FetchTask` or `FetchResponse` depending on the provided options in `init`.
-
-A `FetchResponse` representing the operation with a `string` response.
-
-### 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.
-
-## Call Signature
-
-```ts
-function fetchT(url, init): FetchResponse<ArrayBuffer, Error>
-```
-
-Defined in: [fetch.ts:74](https://github.com/JiangJie/fetch-t/blob/bef789cb418392a07597af77b2942bea27482d3e/src/fetch/fetch.ts#L74)
-
-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`, `Error`\>
-
-A `FetchTask` or `FetchResponse` depending on the provided options in `init`.
-
-A `FetchResponse` representing the operation with an `ArrayBuffer` response.
-
-### 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.
-
-## Call Signature
-
-```ts
-function fetchT(url, init): FetchResponse<Blob, Error>
-```
-
-Defined in: [fetch.ts:85](https://github.com/JiangJie/fetch-t/blob/bef789cb418392a07597af77b2942bea27482d3e/src/fetch/fetch.ts#L85)
-
-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`, `Error`\>
-
-A `FetchTask` or `FetchResponse` depending on the provided options in `init`.
-
-A `FetchResponse` representing the operation with a `Blob` response.
-
-### 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.
-
-## Call Signature
-
-```ts
-function fetchT<T>(url, init): FetchResponse<T, Error>
-```
-
-Defined in: [fetch.ts:97](https://github.com/JiangJie/fetch-t/blob/bef789cb418392a07597af77b2942bea27482d3e/src/fetch/fetch.ts#L97)
-
-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`, `Error`\>
-
-A `FetchTask` or `FetchResponse` depending on the provided options in `init`.
-
-A `FetchResponse` representing the operation with a response parsed as JSON.
-
-### 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.
-
-## Call Signature
-
-```ts
-function fetchT(url, init): FetchTask<Response>
-```
-
-Defined in: [fetch.ts:108](https://github.com/JiangJie/fetch-t/blob/bef789cb418392a07597af77b2942bea27482d3e/src/fetch/fetch.ts#L108)
-
-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` or `FetchResponse` depending on the provided options in `init`.
-
-A `FetchTask` representing the operation with a generic `Response`.
-
-### 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.
-
-## Call Signature
-
-```ts
-function fetchT(url, init?): FetchResponse<Response>
-```
-
-Defined in: [fetch.ts:120](https://github.com/JiangJie/fetch-t/blob/bef789cb418392a07597af77b2942bea27482d3e/src/fetch/fetch.ts#L120)
-
-Fetches a resource from the network and returns a `FetchResponse` or `FetchTask` based on the provided options.
-
-### 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
-
-[`FetchResponse`](../type-aliases/FetchResponse.md)\<`Response`\>
-
-A `FetchTask` or `FetchResponse` depending on the provided options in `init`.
-
-A `FetchResponse` representing the operation with a `Response` object.
-
-### 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.

package/docs/interfaces/FetchInit.md

@@ -1,25 +0,0 @@
-[**@happy-ts/fetch-t**](../README.md)
-
-***
-
-[@happy-ts/fetch-t](../README.md) / FetchInit
-
-# Interface: FetchInit
-
-Defined in: [defines.ts:58](https://github.com/JiangJie/fetch-t/blob/bef789cb418392a07597af77b2942bea27482d3e/src/fetch/defines.ts#L58)
-
-Extends the standard `RequestInit` interface from the Fetch API to include additional custom options.
-
-## Extends
-
-- `RequestInit`
-
-## Properties
-
-| Property | Type | Description | Defined in |
-| ------ | ------ | ------ | ------ |
-| <a id="abortable"></a> `abortable?` | `boolean` | Indicates whether the fetch request should be abortable. | [defines.ts:62](https://github.com/JiangJie/fetch-t/blob/bef789cb418392a07597af77b2942bea27482d3e/src/fetch/defines.ts#L62) |
-| <a id="onchunk"></a> `onChunk?` | (`chunk`: `Uint8Array`) => `void` | Specifies a function to be called when the fetch request receives a chunk of data. | [defines.ts:84](https://github.com/JiangJie/fetch-t/blob/bef789cb418392a07597af77b2942bea27482d3e/src/fetch/defines.ts#L84) |
-| <a id="onprogress"></a> `onProgress?` | (`progressResult`: `IOResult`\<[`FetchProgress`](FetchProgress.md)\>) => `void` | Specifies a function to be called when the fetch request makes progress. | [defines.ts:78](https://github.com/JiangJie/fetch-t/blob/bef789cb418392a07597af77b2942bea27482d3e/src/fetch/defines.ts#L78) |
-| <a id="responsetype"></a> `responseType?` | [`FetchResponseType`](../type-aliases/FetchResponseType.md) | Specifies the expected response type of the fetch request. | [defines.ts:67](https://github.com/JiangJie/fetch-t/blob/bef789cb418392a07597af77b2942bea27482d3e/src/fetch/defines.ts#L67) |
-| <a id="timeout"></a> `timeout?` | `number` | Specifies the maximum time in milliseconds to wait for the fetch request to complete. | [defines.ts:72](https://github.com/JiangJie/fetch-t/blob/bef789cb418392a07597af77b2942bea27482d3e/src/fetch/defines.ts#L72) |

package/docs/interfaces/FetchProgress.md

@@ -1,18 +0,0 @@
-[**@happy-ts/fetch-t**](../README.md)
-
-***
-
-[@happy-ts/fetch-t](../README.md) / FetchProgress
-
-# Interface: FetchProgress
-
-Defined in: [defines.ts:43](https://github.com/JiangJie/fetch-t/blob/bef789cb418392a07597af77b2942bea27482d3e/src/fetch/defines.ts#L43)
-
-Represents the progress of a fetch operation.
-
-## Properties
-
-| Property | Type | Description | Defined in |
-| ------ | ------ | ------ | ------ |
-| <a id="completedbytelength"></a> `completedByteLength` | `number` | The number of bytes received so far. | [defines.ts:52](https://github.com/JiangJie/fetch-t/blob/bef789cb418392a07597af77b2942bea27482d3e/src/fetch/defines.ts#L52) |
-| <a id="totalbytelength"></a> `totalByteLength` | `number` | The total number of bytes to be received. | [defines.ts:47](https://github.com/JiangJie/fetch-t/blob/bef789cb418392a07597af77b2942bea27482d3e/src/fetch/defines.ts#L47) |