kbfetch 0.0.15 → 0.0.16

package/README.md

@@ -1,76 +1,108 @@
-# kbfetch
+# kbfetch 库使用说明
 
-一个轻量基于fetch封装的API请求工具库。
+`kbfetch` 一个轻量基于fetch封装的API请求工具库。
 
-## 安装
+## 安装引用
 
-```
+```bash
 npm install kbfetch
 ```
 
-## 使用
-
-kbfetch导出了一些类型定义和默认的fetch助手函数:
-
-```ts
-import fetch, { KbFetchInit } from 'kbfetch';
-
-const response = await fetch('/api/users', {
-  method: 'GET'
-} as KbFetchInit);
+```javascript
+import kbfetch from 'kbfetch'
 ```
 
-`KbFetchInit` 类型扩展了标准的 `RequestInit`,添加了一些可选的便捷属性:
+## 接口和方法
 
-- `baseUrl` - API的基础网址
-- `timeout` - 请求超时时间(毫秒)
-- `before` - 修改/记录请求参数的回调函数
-- `after` - 响应结果的回调函数  
-- `parser` - 在返回resolve前解析响应的回调函数
+`kbfetch` 提供了以下方法：
 
-示例使用部分属性:
+- `baseUrl`: 字符串，表示默认的基本 URL。
+- `before(init: kbfetchInit): kbfetchInit`: 对请求初始化对象进行预处理的函数。
+- `after(res: Promise<Response & { data: any }>): any`: 对响应结果进行后处理的函数。
+- `parser(res: Response): any`: 对响应数据进行解析的函数。
+- `timeout: number`: 请求超时时间（毫秒）。
 
-```ts 
-const response = await fetch('/users', {
-  baseUrl: 'https://example.com/api',
-  timeout: 10000,
-  parser: res => res.json()
-});
-```
+## 使用示例
 
-同时导出了一个默认的`fetch`实例`afetch`,包含一些常用的默认配置。
+发起 GET 请求的示例：
 
-## API
+```javascript
+import kbfetch from 'kbfetch'
+kbfetch.g('https://api.example.com/data', { id: 1 })
+// OR
+kbfetch.get('https://api.example.com/data', {
+    params: { id: 1 }
+})
+```
 
-### 类型
+发起 POST 请求的示例：
 
-- `KbFetchInit` - 扩展了便捷请求属性的RequestInit
+```js
+kbfetch.post('https://api.example.com/data', { id: 1 })
+```
 
-### 函数
+取消请求示例：
+`timeout!=-1时,canAbort可以不设置`
 
-- `fetch` - 使用提供的初始化选项发起请求
-- `afetch` - 配置好默认值的fetch实例
+```js
+const ft = kbfetch.post('https://api.example.com/data', { id: 1 }, { canAbort: true })
+ft.abort()
+```
 
-### 配置
+```js
+const ft = kbfetch.g('https://api.example.com/data', { params: { id: 1 }, timeout: 0 })
+ft.abort()
+```
 
-可以使用`createKbFetch`创建自定义的`fetch`实例:
+## 自定义选项
 
-```ts
-import { createKbFetch } from 'kbfetch';
+`KbFetchInit` 类型扩展了标准的 `RequestInit`,添加了一些可选的便捷属性:
 
-const customFetch = createKbFetch({
-  baseUrl: 'https://api.example.com'
-});
+- `baseUrl` - API的基础网址
+- `timeout` - 请求超时时间(毫秒)
+- `before` - 修改/记录请求参数的回调函数
+- `parser` - 在返回resolve前解析响应的回调函数
+- `after` - 响应结果的回调函数
+
+```typescript
+import kbfetch, { createKbFetch } from 'kbfetch'
+// 请求单独配置
+kbfetch.post(url, data, kbFetchInit)
+kbfetch.get(url, params, kbFetchInit)
+// 创建自定义实例
+const ft = createKbFetch(KbFetchInit)
+// ft.get ft.post
 ```
 
-可以提供以下选项进行配置:
-
-- `baseUrl` - API的基地址
-- `timeout` - 全局超时时间
-- `before` - 全局before回调函数
-- `after` - 全局after回调函数
-- `parser` - 全局parser回调函数
+fetch SSE 实现示例:
+
+```javascript
+import kbfetch from 'kbfetch'
+const sse = (name: string, params: { ondata: (data: string) => any } & Record<string, any>) => {
+    const { ondata, ..._p } = params
+    return kbfetch.post(name, _p, {
+        timeout: 0,
+        parser: rb => {
+            if (!rb.body) return
+            const reader = rb.body.getReader()
+            const push = () => {
+                // done 为数据流是否接收完成，boolean
+                // value 为返回数据，Uint8Array
+                return reader.read().then(({ done, value }) => {
+                    if (done) return
+                    ondata(new TextDecoder().decode(value))
+                    // 持续读取流信息
+                    return push()
+                })
+            }
+            // 开始读取流信息
+            return push()
+        },
+        after: v => v
+    })
+}
+```
 
-## 许可
+在这个示例中，我们自定义了 `before` 和 `after` 函数，以修改请求初始化对象和响应结果。
 
-MIT
+更多关于 `kbfetchInit` 对象的详细信息，请参考原始的 TypeScript 定义文件。

package/dist/index.js

@@ -48,8 +48,7 @@ var defaultKbFetch = {
     if (!url.startsWith("http://") && !url.startsWith("https://"))
       url = baseUrl + url;
     const response = fetch(url, requestInit).then(async (respnse) => Object.assign(respnse, { data: await parser(respnse) }));
-    const res = after(response);
-    return Object.assign(res, {
+    return Object.assign(after(response), {
       abort: () => abortController?.abort()
     });
   },
@@ -69,9 +68,7 @@ var defaultKbFetch = {
 var createKbFetch = (config) => ({ ...defaultKbFetch, ...config });
 var kbFetch = defaultKbFetch;
 var kbfetch_default = kbFetch;
-var afetch = defaultKbFetch;
 export {
   kbfetch_default as default,
-  createKbFetch,
-  afetch
+  createKbFetch
 };

package/dist/typings/index.d.ts

@@ -1,13 +1,12 @@
 import { DefaultKbFetch, KbFetchInit } from './help';
-declare const defaultKbFetch: DefaultKbFetch;
-export declare const createKbFetch: (config: Partial<typeof defaultKbFetch>) => {
-    baseUrl: string;
-    before: (init: KbFetchInit) => KbFetchInit;
+export declare const createKbFetch: (config: Partial<Pick<DefaultKbFetch, 'baseUrl' | 'timeout' | 'before' | 'parser' | 'after'>>) => {
     after: (res: Promise<Response & {
         data: any;
     }>) => any;
-    parser: (res: Response) => any;
+    before: (init: KbFetchInit) => KbFetchInit;
     timeout: number;
+    parser: (res: Response) => any;
+    baseUrl: string;
     do: <T>(url: string, init?: KbFetchInit) => Promise<T> & {
         abort: () => void;
     };
@@ -37,4 +36,3 @@ export declare const createKbFetch: (config: Partial<typeof defaultKbFetch>) =>
 };
 declare const kbFetch: DefaultKbFetch;
 export default kbFetch;
-export declare const afetch: DefaultKbFetch;

package/package.json

@@ -3,7 +3,7 @@
     "main": "./dist/index.js",
     "module": "./dist/index.js",
     "type": "module",
-    "version": "0.0.15",
+    "version": "0.0.16",
     "license": "MIT",
     "types": "./dist/typings/index.d.ts",
     "files": [