axios-wrapper-pro 1.0.0 → 1.0.1

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.
Files changed (2) hide show
  1. package/README.md +24 -23
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -23,21 +23,22 @@ npm install axios-wrapper-pro
23
23
  ### 基本使用
24
24
 
25
25
  ```typescript
26
- import { AxiosWrapperPro } from 'axios-wrapper-pro';
26
+ import { AxiosWrapperPro } from "axios-wrapper-pro";
27
27
 
28
28
  const axiosWrapperPro = new AxiosWrapperPro({
29
- baseURL: 'https://api.example.com',
29
+ baseURL: "https://api.example.com",
30
30
  timeout: 10000,
31
31
  headers: {
32
- 'Content-Type': 'application/json'
33
- }
32
+ "Content-Type": "application/json",
33
+ colorTag: "dev",
34
+ },
34
35
  });
35
36
 
36
37
  // GET 请求
37
- const response = await axiosWrapperPro.get('/users');
38
+ const response = await axiosWrapperPro.get("/users");
38
39
 
39
40
  // POST 请求
40
- const response = await axiosWrapperPro.post('/users', { name: 'John' });
41
+ const response = await axiosWrapperPro.post("/users", { name: "John" });
41
42
  ```
42
43
 
43
44
  ### 配置重试
@@ -52,16 +53,16 @@ const axiosWrapperPro = new AxiosWrapperPro({
52
53
  // 网络错误或 5xx 错误时重试
53
54
  if (!error?.response) return true;
54
55
  return error?.response?.status >= 500;
55
- }
56
- }
56
+ },
57
+ },
57
58
  });
58
59
 
59
60
  // 单次请求重试配置
60
- await axiosWrapperPro.get('/users', {
61
+ await axiosWrapperPro.get("/users", {
61
62
  retry: {
62
63
  count: 2,
63
- delay: 500
64
- }
64
+ delay: 500,
65
+ },
65
66
  });
66
67
  ```
67
68
 
@@ -69,20 +70,20 @@ await axiosWrapperPro.get('/users', {
69
70
 
70
71
  ```typescript
71
72
  // 使用 requestKey 进行请求去重
72
- const response1 = await axiosWrapperPro.get('/users', {
73
- requestKey: 'get-users'
73
+ const response1 = await axiosWrapperPro.get("/users", {
74
+ requestKey: "get-users",
74
75
  });
75
76
  // 相同的 requestKey 会取消之前的请求
76
- const response2 = await axiosWrapperPro.get('/users', {
77
- requestKey: 'get-users'
77
+ const response2 = await axiosWrapperPro.get("/users", {
78
+ requestKey: "get-users",
78
79
  });
79
80
 
80
81
  // 使用 Symbol 作为 requestKey
81
- const myKey = Symbol('my-request');
82
- await axiosWrapperPro.get('/data', { requestKey: myKey });
82
+ const myKey = Symbol("my-request");
83
+ await axiosWrapperPro.get("/data", { requestKey: myKey });
83
84
 
84
85
  // 取消指定请求
85
- axiosWrapperPro.cancelRequest('get-users');
86
+ axiosWrapperPro.cancelRequest("get-users");
86
87
  // 取消所有请求
87
88
  axiosWrapperPro.cancelAllRequests();
88
89
  ```
@@ -119,16 +120,16 @@ axiosWrapperPro.setResponseInterceptor(
119
120
 
120
121
  ```typescript
121
122
  // 设置单个请求头
122
- axiosWrapperPro.setHeader('Authorization', 'Bearer token');
123
+ axiosWrapperPro.setHeader("Authorization", "Bearer token");
123
124
 
124
125
  // 批量设置请求头
125
126
  axiosWrapperPro.setHeaders({
126
- 'X-Custom-Header': 'value',
127
- 'X-Another-Header': 'value'
127
+ "X-Custom-Header": "value",
128
+ "X-Another-Header": "value",
128
129
  });
129
130
 
130
131
  // 移除请求头
131
- axiosWrapperPro.removeHeader('X-Custom-Header');
132
+ axiosWrapperPro.removeHeader("X-Custom-Header");
132
133
  ```
133
134
 
134
135
  ## API
@@ -250,4 +251,4 @@ type RequestKey = string | symbol;
250
251
 
251
252
  ## 许可证
252
253
 
253
- MIT
254
+ MIT
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "axios-wrapper-pro",
3
- "version": "1.0.0",
3
+ "version": "1.0.1",
4
4
  "description": "基于 Axios 的增强型 HTTP 客户端,支持请求去重、自动取消、重试机制和可配置拦截器",
5
5
  "scripts": {
6
6
  "build": "tsc",