kbfetch 0.0.5 → 0.0.7

package/README.md

@@ -0,0 +1,76 @@
+# kbfetch
+
+一个轻量基于fetch封装的API请求工具库。
+
+## 安装
+
+```
+npm install kbfetch
+```
+
+## 使用
+
+kbfetch导出了一些类型定义和默认的fetch助手函数:
+
+```ts
+import fetch, { KbFetchInit } from 'kbfetch';
+
+const response = await fetch('/api/users', {
+  method: 'GET'
+} as KbFetchInit);
+```
+
+`KbFetchInit` 类型扩展了标准的 `RequestInit`,添加了一些可选的便捷属性:
+
+- `baseUrl` - API的基础网址
+- `timeout` - 请求超时时间(毫秒)
+- `before` - 修改/记录请求参数的回调函数
+- `after` - 响应结果的回调函数  
+- `parser` - 在返回resolve前解析响应的回调函数
+
+示例使用部分属性:
+
+```ts 
+const response = await fetch('/users', {
+  baseUrl: 'https://example.com/api',
+  timeout: 10000,
+  parser: res => res.json()
+});
+```
+
+同时导出了一个默认的`fetch`实例`afetch`,包含一些常用的默认配置。
+
+## API
+
+### 类型
+
+- `KbFetchInit` - 扩展了便捷请求属性的RequestInit
+
+### 函数
+
+- `fetch` - 使用提供的初始化选项发起请求
+- `afetch` - 配置好默认值的fetch实例
+
+### 配置
+
+可以使用`createKbFetch`创建自定义的`fetch`实例:
+
+```ts
+import { createKbFetch } from 'kbfetch';
+
+const customFetch = createKbFetch({
+  baseUrl: 'https://api.example.com'
+});
+```
+
+可以提供以下选项进行配置:
+
+- `baseUrl` - API的基地址
+- `timeout` - 全局超时时间
+- `before` - 全局before回调函数
+- `after` - 全局after回调函数
+- `parser` - 全局parser回调函数
+
+## 许可
+
+MIT

package/dist/index.js

@@ -20,6 +20,11 @@ var help = {
     if (contentType.includes("application/json"))
       return res.json();
     return res.text();
+  },
+  obj2header: (obj) => {
+    const headers = new Headers;
+    Object.entries(obj).forEach(([k, v]) => headers.append(k, v));
+    return headers;
   }
 };
 var help_default = help;
@@ -35,8 +40,8 @@ var defaultKbFetch = {
     const _t = this;
     let { before = _t.before, ..._init } = init || {};
     _init = before(_init);
-    let { parser = _t.parser, after = _t.after, baseUrl = _t.baseUrl, timeout = _t.timeout, ...requestInit } = _init;
-    timeout && Object.assign(requestInit, { signal: help_default.createTimeoutSignal(timeout) });
+    let { parser = _t.parser, after = _t.after, baseUrl = _t.baseUrl, timeout = _t.timeout, headers = {}, ...requestInit } = _init;
+    timeout && Object.assign(requestInit, { signal: help_default.createTimeoutSignal(timeout), headers: help_default.obj2header(headers) });
     if (!url.startsWith("http://") && !url.startsWith("https://"))
       url = baseUrl + url;
     const response = fetch(url, requestInit).then(async (respnse) => {

package/dist/typings/help.d.ts

@@ -4,17 +4,20 @@ type After = <T = any>(res: Promise<Response & {
     data: T;
 }>) => any;
 type _KbFetchInit = {
-    timeout?: number;
     before?: Before;
     parser?: Parser;
     after?: After;
     baseUrl?: string;
     flags?: Record<string, any>;
 };
-export type KbFetchInit = Omit<RequestInit, 'timeout'> & _KbFetchInit;
+export type KbFetchInit = Omit<RequestInit, 'timeout' | 'headers'> & {
+    timeout?: number;
+    headers?: Record<string, string>;
+} & _KbFetchInit;
 declare const help: {
     synthesizeUrlWithParams: (url: string, params?: Record<string, any>) => string;
     createTimeoutSignal: (timeout: number) => AbortSignal;
     parseResBody: (res: Response) => Promise<any>;
+    obj2header: (obj: Record<string, string>) => Headers;
 };
 export default help;

package/dist/typings/index.d.ts

@@ -9,8 +9,10 @@ declare const defaultKbFetch: {
     timeout: number;
     do: <T = any>(url: string, init?: KbFetchInit) => Promise<any>;
     get: <T_1 = any>(url: string, params?: Record<string, any>, init?: KbFetchInit) => Promise<T_1>;
-    g: <T_2 = any>(url: string, init?: Omit<RequestInit, "timeout"> & {
+    g: <T_2 = any>(url: string, init?: Omit<RequestInit, "timeout" | "headers"> & {
         timeout?: number;
+        headers?: Record<string, string>;
+    } & {
         before?: (init: KbFetchInit) => KbFetchInit;
         parser?: (res: Response) => any;
         after?: <T_3 = any>(res: Promise<Response & {
@@ -33,8 +35,10 @@ export declare const createKbFetch: (config: Partial<typeof defaultKbFetch>) =>
     timeout: number;
     do: <T = any>(url: string, init?: KbFetchInit) => Promise<any>;
     get: <T_1 = any>(url: string, params?: Record<string, any>, init?: KbFetchInit) => Promise<T_1>;
-    g: <T_2 = any>(url: string, init?: Omit<RequestInit, "timeout"> & {
+    g: <T_2 = any>(url: string, init?: Omit<RequestInit, "timeout" | "headers"> & {
         timeout?: number;
+        headers?: Record<string, string>;
+    } & {
         before?: (init: KbFetchInit) => KbFetchInit;
         parser?: (res: Response) => any;
         after?: <T_3 = any>(res: Promise<Response & {
@@ -57,8 +61,10 @@ declare const kbFetch: {
     timeout: number;
     do: <T = any>(url: string, init?: KbFetchInit) => Promise<any>;
     get: <T_1 = any>(url: string, params?: Record<string, any>, init?: KbFetchInit) => Promise<T_1>;
-    g: <T_2 = any>(url: string, init?: Omit<RequestInit, "timeout"> & {
+    g: <T_2 = any>(url: string, init?: Omit<RequestInit, "timeout" | "headers"> & {
         timeout?: number;
+        headers?: Record<string, string>;
+    } & {
         before?: (init: KbFetchInit) => KbFetchInit;
         parser?: (res: Response) => any;
         after?: <T_3 = any>(res: Promise<Response & {
@@ -82,8 +88,10 @@ export declare const afetch: {
     timeout: number;
     do: <T = any>(url: string, init?: KbFetchInit) => Promise<any>;
     get: <T_1 = any>(url: string, params?: Record<string, any>, init?: KbFetchInit) => Promise<T_1>;
-    g: <T_2 = any>(url: string, init?: Omit<RequestInit, "timeout"> & {
+    g: <T_2 = any>(url: string, init?: Omit<RequestInit, "timeout" | "headers"> & {
         timeout?: number;
+        headers?: Record<string, string>;
+    } & {
         before?: (init: KbFetchInit) => KbFetchInit;
         parser?: (res: Response) => any;
         after?: <T_3 = any>(res: Promise<Response & {

package/package.json

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