@happy-ts/fetch-t 1.3.2 → 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.2",
+  "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,23 +47,29 @@
     "fetch",
     "abort",
     "cancel",
-    "responseType"
+    "timeout",
+    "progress",
+    "streaming",
+    "type-safe",
+    "typescript",
+    "result",
+    "async"
   ],
   "devDependencies": {
-    "@eslint/js": "^9.9.0",
-    "@types/eslint__js": "^8.42.3",
-    "eslint": "^9.9.0",
-    "rollup": "^4.20.0",
-    "rollup-plugin-dts": "^6.1.1",
-    "rollup-plugin-esbuild": "^6.1.1",
-    "typedoc": "^0.26.5",
-    "typedoc-plugin-markdown": "^4.2.3",
-    "typescript": "^5.5.4",
-    "typescript-eslint": "^8.0.1"
+    "@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.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"
-  },
-  "packageManager": "pnpm@9.7.0"
+  }
 }

package/dist/types.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.d.ts","sources":[],"sourcesContent":[],"names":[],"mappings":""}

package/docs/README.md

@@ -1,39 +0,0 @@
-**@happy-ts/fetch-t** • **Docs**
-
-***
-
-# @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 as a text string and returns a `FetchTask` representing the operation. |

package/docs/classes/FetchError.md

@@ -1,47 +0,0 @@
-[**@happy-ts/fetch-t**](../README.md) • **Docs**
-
-***
-
-[@happy-ts/fetch-t](../README.md) / FetchError
-
-# Class: FetchError
-
-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
-```
-
-#### Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `message` | `string` |
-| `status` | `number` |
-
-#### Returns
-
-[`FetchError`](FetchError.md)
-
-#### Overrides
-
-`Error.constructor`
-
-#### Defined in
-
-[defines.ts:100](https://github.com/JiangJie/fetch-t/blob/61346c95bab5342bcbd9e97bca747ef24af2eac6/src/fetch/defines.ts#L100)
-
-## Properties
-
-| Property | Type | Default value | Description | Overrides | Defined in |
-| ------ | ------ | ------ | ------ | ------ | ------ |
-| `name` | `string` | `'FetchError'` | The name of the error. | `Error.name` | [defines.ts:94](https://github.com/JiangJie/fetch-t/blob/61346c95bab5342bcbd9e97bca747ef24af2eac6/src/fetch/defines.ts#L94) |
-| `status` | `number` | `0` | The status code of the response. | - | [defines.ts:98](https://github.com/JiangJie/fetch-t/blob/61346c95bab5342bcbd9e97bca747ef24af2eac6/src/fetch/defines.ts#L98) |

package/docs/functions/fetchT.md

@@ -1,423 +0,0 @@
-[**@happy-ts/fetch-t**](../README.md) • **Docs**
-
-***
-
-[@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.
-
-## 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` 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.
-
-### Defined in
-
-[fetch.ts:14](https://github.com/JiangJie/fetch-t/blob/61346c95bab5342bcbd9e97bca747ef24af2eac6/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` 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.
-
-### Defined in
-
-[fetch.ts:26](https://github.com/JiangJie/fetch-t/blob/61346c95bab5342bcbd9e97bca747ef24af2eac6/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` 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.
-
-### Defined in
-
-[fetch.ts:38](https://github.com/JiangJie/fetch-t/blob/61346c95bab5342bcbd9e97bca747ef24af2eac6/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` 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.
-
-### Defined in
-
-[fetch.ts:51](https://github.com/JiangJie/fetch-t/blob/61346c95bab5342bcbd9e97bca747ef24af2eac6/src/fetch/fetch.ts#L51)
-
-## fetchT(url, init)
-
-```ts
-function fetchT(url, init): FetchResponse<string, Error>
-```
-
-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.
-
-### Defined in
-
-[fetch.ts:63](https://github.com/JiangJie/fetch-t/blob/61346c95bab5342bcbd9e97bca747ef24af2eac6/src/fetch/fetch.ts#L63)
-
-## fetchT(url, init)
-
-```ts
-function fetchT(url, init): FetchResponse<ArrayBuffer, Error>
-```
-
-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.
-
-### Defined in
-
-[fetch.ts:74](https://github.com/JiangJie/fetch-t/blob/61346c95bab5342bcbd9e97bca747ef24af2eac6/src/fetch/fetch.ts#L74)
-
-## fetchT(url, init)
-
-```ts
-function fetchT(url, init): FetchResponse<Blob, Error>
-```
-
-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.
-
-### Defined in
-
-[fetch.ts:85](https://github.com/JiangJie/fetch-t/blob/61346c95bab5342bcbd9e97bca747ef24af2eac6/src/fetch/fetch.ts#L85)
-
-## fetchT(url, init)
-
-```ts
-function fetchT<T>(url, init): FetchResponse<T, Error>
-```
-
-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.
-
-### Defined in
-
-[fetch.ts:97](https://github.com/JiangJie/fetch-t/blob/61346c95bab5342bcbd9e97bca747ef24af2eac6/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` 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.
-
-### Defined in
-
-[fetch.ts:108](https://github.com/JiangJie/fetch-t/blob/61346c95bab5342bcbd9e97bca747ef24af2eac6/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` 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.
-
-### Defined in
-
-[fetch.ts:120](https://github.com/JiangJie/fetch-t/blob/61346c95bab5342bcbd9e97bca747ef24af2eac6/src/fetch/fetch.ts#L120)

package/docs/interfaces/FetchInit.md

@@ -1,23 +0,0 @@
-[**@happy-ts/fetch-t**](../README.md) • **Docs**
-
-***
-
-[@happy-ts/fetch-t](../README.md) / FetchInit
-
-# Interface: FetchInit
-
-Extends the standard `RequestInit` interface from the Fetch API to include additional custom options.
-
-## Extends
-
-- `RequestInit`
-
-## Properties
-
-| Property | Type | Description | Defined in |
-| ------ | ------ | ------ | ------ |
-| `abortable?` | `boolean` | Indicates whether the fetch request should be abortable. | [defines.ts:62](https://github.com/JiangJie/fetch-t/blob/61346c95bab5342bcbd9e97bca747ef24af2eac6/src/fetch/defines.ts#L62) |
-| `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/61346c95bab5342bcbd9e97bca747ef24af2eac6/src/fetch/defines.ts#L84) |
-| `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/61346c95bab5342bcbd9e97bca747ef24af2eac6/src/fetch/defines.ts#L78) |
-| `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/61346c95bab5342bcbd9e97bca747ef24af2eac6/src/fetch/defines.ts#L67) |
-| `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/61346c95bab5342bcbd9e97bca747ef24af2eac6/src/fetch/defines.ts#L72) |

package/docs/interfaces/FetchProgress.md

@@ -1,16 +0,0 @@
-[**@happy-ts/fetch-t**](../README.md) • **Docs**
-
-***
-
-[@happy-ts/fetch-t](../README.md) / FetchProgress
-
-# Interface: FetchProgress
-
-Represents the progress of a fetch operation.
-
-## Properties
-
-| Property | Type | Description | Defined in |
-| ------ | ------ | ------ | ------ |
-| `completedByteLength` | `number` | The number of bytes received so far. | [defines.ts:52](https://github.com/JiangJie/fetch-t/blob/61346c95bab5342bcbd9e97bca747ef24af2eac6/src/fetch/defines.ts#L52) |
-| `totalByteLength` | `number` | The total number of bytes to be received. | [defines.ts:47](https://github.com/JiangJie/fetch-t/blob/61346c95bab5342bcbd9e97bca747ef24af2eac6/src/fetch/defines.ts#L47) |