@polyv/request-plugin-status-code 2.7.0 → 2.8.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +18 -19
- package/package.json +5 -3
- package/status-code-plugin.d.ts +1 -1
package/README.md
CHANGED
|
@@ -4,32 +4,32 @@
|
|
|
4
4
|
|
|
5
5
|
## 实例化参数
|
|
6
6
|
|
|
7
|
-
| 参数名
|
|
8
|
-
|
|
|
9
|
-
| `successCode`
|
|
10
|
-
| `fields`
|
|
11
|
-
| `errorCallback` | 请求失败回调函数 | `function`
|
|
7
|
+
| 参数名 | 用途 | 类型 | 默认值 |
|
|
8
|
+
| --------------- | ---------------- | -------------------- | ------ |
|
|
9
|
+
| `successCode` | 请求成功状态码 | `number \| number[]` | `200` |
|
|
10
|
+
| `fields` | 状态码字段配置 | `StatusCodeFields` | 见下文 |
|
|
11
|
+
| `errorCallback` | 请求失败回调函数 | `function` | - |
|
|
12
12
|
|
|
13
13
|
## 请求选项
|
|
14
14
|
|
|
15
|
-
| 参数名
|
|
16
|
-
|
|
|
17
|
-
| `useStatusCode` | 是否使用状态码判断 | `boolean`
|
|
18
|
-
| `successCode`
|
|
15
|
+
| 参数名 | 用途 | 类型 | 默认值 |
|
|
16
|
+
| --------------- | ------------------ | -------------------- | ------ |
|
|
17
|
+
| `useStatusCode` | 是否使用状态码判断 | `boolean` | `true` |
|
|
18
|
+
| `successCode` | 成功状态码 | `number \| number[]` | - |
|
|
19
19
|
|
|
20
20
|
## 状态码字段配置
|
|
21
21
|
|
|
22
22
|
`StatusCodeFields` 类型如下：
|
|
23
23
|
|
|
24
|
-
| 参数名
|
|
25
|
-
|
|
|
26
|
-
| `codeField`
|
|
27
|
-
| `statusField`
|
|
28
|
-
| `messageField`
|
|
29
|
-
| `dataField`
|
|
30
|
-
| `errorField`
|
|
31
|
-
| `errorCodeField` | 错误对象中的错误码字段名
|
|
32
|
-
| `errorDescField` | 错误对象中的错误描述字段名 | `string` | `'desc'`
|
|
24
|
+
| 参数名 | 用途 | 类型 | 默认值 |
|
|
25
|
+
| ---------------- | -------------------------- | -------- | ----------- |
|
|
26
|
+
| `codeField` | 状态码字段名 | `string` | `'code'` |
|
|
27
|
+
| `statusField` | 状态字段名 | `string` | `'status'` |
|
|
28
|
+
| `messageField` | 消息字段名 | `string` | `'message'` |
|
|
29
|
+
| `dataField` | 数据字段名 | `string` | `'data'` |
|
|
30
|
+
| `errorField` | 错误对象字段名 | `string` | `'error'` |
|
|
31
|
+
| `errorCodeField` | 错误对象中的错误码字段名 | `string` | `'code'` |
|
|
32
|
+
| `errorDescField` | 错误对象中的错误描述字段名 | `string` | `'desc'` |
|
|
33
33
|
|
|
34
34
|
## 使用方式
|
|
35
35
|
|
|
@@ -101,4 +101,3 @@ requester.get('/api/data', {}, {
|
|
|
101
101
|
4. 失败时抛出错误，错误信息包含：
|
|
102
102
|
- `code`: 优先使用 `error.code` 字段，其次使用顶层 `code` 字段
|
|
103
103
|
- `message`: 优先使用 `error.desc` 字段，其次使用顶层 `message` 字段，都不存在则为 `'未知错误'`
|
|
104
|
-
|
package/package.json
CHANGED
|
@@ -1,9 +1,11 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@polyv/request-plugin-status-code",
|
|
3
|
-
"version": "2.
|
|
3
|
+
"version": "2.8.0",
|
|
4
4
|
"main": "./index.js",
|
|
5
5
|
"dependencies": {
|
|
6
|
-
"@polyv/request-core": "2.
|
|
6
|
+
"@polyv/request-core": "2.8.0"
|
|
7
7
|
},
|
|
8
|
-
"types": "./index.d.ts"
|
|
8
|
+
"types": "./index.d.ts",
|
|
9
|
+
"type": "module",
|
|
10
|
+
"miniprogram": "./"
|
|
9
11
|
}
|
package/status-code-plugin.d.ts
CHANGED