@seayoo-web/request 0.6.0 → 0.6.1

package/README.md

@@ -12,7 +12,7 @@
 ## 特性
 
 1. 默认基于 fetch，请求和响应均 基于 json 或 text（不支持其他格式）
-2. 支持重试配置 maxRry / retryResolve / retryInterval
+2. 支持重试配置 maxRetry / retryResolve / retryInterval
 3. 支持响应结果处理策略 responseRule 和通用提示配置
 4. 支持类型守卫 typeGuard
 5. 支持多实例，多端（浏览器，nodejs，并可以扩展小程序）
@@ -23,7 +23,7 @@
 ## 示例
 
 ```js
-const { get, post, put } from "@seayoo-web/request"
+import { get } from "@seayoo-web/request"
 
 interface IUser {
     name: string,
@@ -45,14 +45,13 @@ export async function getUserList(): Promise<IUser[]> {
 
 ```js
 // 浏览器环境
-const { setGlobalConfig } from "@seayoo-web/request"
+import { setGlobalConfig } from "@seayoo-web/request"
 // nodejs 环境
-const { setGlobalConfig } from "@seayoo-web/request/node"
+import { setGlobalConfig } from "@seayoo-web/request/node"
 
 // 以下是默认的全局配置（更多介绍请参考下方全局配置）
 setGlobalConfig({
     // api 基础路径，默认根目录，通常可以设置为 /api
-    // nodejs 环境下此配置无效
     baseURL: "",
     // 响应解析规则
     responseRule: {
@@ -69,31 +68,31 @@ setGlobalConfig({
 
 ```js
 // 以下为浏览器环境全局默认导出的工具函数
-const { get, post, put, patch, del, head } from "@seayoo-web/request"
+import { get, post, put, patch, del, head } from "@seayoo-web/request"
 
 // 以下是 nodejs 环境全局默认导出的工具函数
-const { get, post, put, patch, del, head } from "@seayoo-web/request/node"
+import { get, post, put, patch, del, head } from "@seayoo-web/request/node"
 
 // 浏览器环境自定义创建实例
-const { NetRequest } from "@seayoo-web/request"
+import { NetRequest } from "@seayoo-web/request"
 const { get, post, put, patch, del, setConfig } = NetRequest()
 
 // nodejs环境自定义创建实例
-const { NetRequest } from "@seayoo-web/request/node"
+import { NetRequest } from "@seayoo-web/request/node"
 const { get, post, put, patch, del, setConfig } = NetRequest()
 ```
 
 ## 全局配置参数
 
 ```js
-const { setGlobalConfig } from "@seayoo-web/request"
+import { setGlobalConfig } from "@seayoo-web/request"
 // 全局配置字段说明见下，所有字段均可选
-// 全局配置仅仅影响全局导出函数，比如 get, post 等，对于自行创建的工具类没有影响
+// 全局配置仅仅影响全局导出函数，比如 get, post 等，对于自定义实例没有影响
 setGlobalConfig({ baseURL: "/api" })
 
 // 自定义实例全局配置是独立的
-const { NetRequest } from "@seayoo-web/request"
-// 可以 new 时传递
+import { NetRequest } from "@seayoo-web/request"
+// 可以创建时传递
 const { get, post, setConfig } = NetRequest({ baseURL: "/api" })
 // 也可以随时修改
 setConfig({ timeout: 5000 })
@@ -150,11 +149,11 @@ setConfig({ timeout: 5000 })
 
   **resolve**: "json" | "body" | "auto"
 
-  ​	解析方式，如果解析方式为 json，则可以进一步指定错误消息字段
+  ​	解析方式，设置为 json（默认），则可以进一步指定错误消息字段；设置为 body 则将整个 body 解析为错误信息；设置为 auto 则尝试上述两种策略；
 
   **messageField**: string
 
-  ​	错误消息解析字段，仅在 resolve 为 json 时有效
+  ​	错误消息解析字段，仅在 resolve 为 json 或 auto 时有效，默认值 message
 
 - **OKRule**: { resolve, statusField?, statusOKValue?, dataField?, messageField?, ignoreMessage? }
 
@@ -162,7 +161,7 @@ setConfig({ timeout: 5000 })
 
   **resolve**: "json" | "body"
 
-  ​	解析方式，若解析方式为 json，则可以进一步指定更多字段；若解析为 body，则把整个响应体作为接口返回的数据使用，如果格式化失败，则返回 body 本身的字符串；
+  ​	解析方式，若设置为 json，则可以进一步指定更多字段；若设置为 body（默认），则把整个响应体作为接口返回的数据使用，如果格式化失败，则返回响应的字符串；
 
   **statusField**: string
 
@@ -198,7 +197,7 @@ setConfig({ timeout: 5000 })
 
 类型：number | ((retryIndex: number) => number)
 
-说明：两次重试的间隔策略，设置为数字（单位 ms）表示固定间隔，设置为 函数则可以自定义间隔；其中 retryIndex 从 1 开始，最大为 10；最小时间间隔为 100ms；
+说明：两次重试的间隔策略，设置为数字（单位 ms）表示固定间隔，设置为函数则可以自定义间隔；其中 retryIndex 从 1 开始，最大为 10；最小时间间隔为 100ms；
 
 ### headerHandler
 
@@ -222,7 +221,7 @@ setConfig({ timeout: 5000 })
 
 类型：null | ((data: IRequestLog) => void)
 
-说明：全局日志打印函数，目前仅仅输出请求开始和完成的日志，具体日志信息可参考源码 types 声明；
+说明：全局日志打印函数，目前仅仅输出请求开始和完成的日志，具体日志信息可参考 types 声明；
 
 ## 网络请求参数
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@seayoo-web/request",
-  "version": "0.6.0",
+  "version": "0.6.1",
   "description": "requst tools for seayoo web",
   "type": "module",
   "main": "dist/index.mjs",