node-easywechat 3.1.0 → 3.1.1

package/CHANGELOG.md

@@ -1,6 +1,10 @@
 # CHANGELOG
 
 
+## v3.1.1 (2022-11-15)
+
+- Feat: 增加请求失败时的重试机制，具体见配置项http.retry
+
 ## v3.1.0 (2022-11-09)
 
 - Feat: 新增开放平台模块
@@ -9,6 +13,8 @@
 - Fix: 修复配置项类型判断异常的问题
 - Fix: 修复请求客户端无法设置请求是否错误判断逻辑的方法
 
+- Docs: 增加开放平台的说明
+
 - Perf: 优化url路径解析方法
 
 ## v3.0.1 (2022-08-26)

package/README.md

@@ -78,7 +78,11 @@ let data = response.toObject();
 {
   // axios 请求参数
   // 详见：https://github.com/axios/axios#request-config
-  http: {},
+  http: {
+    // 请求失败时，自动重试。默认不重试
+    // 详见：https://github.com/softonic/axios-retry#options
+    retry: {}
+  },
 
   // 缓存以文件(默认设置)存储时，需要的配置项
   file_cache: {

package/dist/Core/HttpClient/HttpClient.d.ts

@@ -1,7 +1,7 @@
 import { AxiosInstance, AxiosRequestConfig, Method } from 'axios';
 import HttpClientInterface from './Contracts/HttpClientInterface';
 import HttpClientResponse from './HttpClientResponse';
-import { HttpClientFailureJudgeClosure, LogHandler } from '../../Types/global';
+import { HttpClientFailureJudgeClosure, HttpConfig, LogHandler } from '../../Types/global';
 import FormData from 'form-data';
 declare class HttpClient implements HttpClientInterface {
     protected axios: AxiosInstance;
@@ -28,6 +28,6 @@ declare class HttpClient implements HttpClientInterface {
      * @param config
      * @returns
      */
-    static create(config?: AxiosRequestConfig, failureJudge?: HttpClientFailureJudgeClosure, throwError?: boolean): HttpClient;
+    static create(config?: HttpConfig, failureJudge?: HttpClientFailureJudgeClosure, throwError?: boolean): HttpClient;
 }
 export = HttpClient;

package/dist/Core/HttpClient/HttpClient.js

@@ -15,6 +15,7 @@ const axios_1 = __importDefault(require("axios"));
 const HttpClientResponse_1 = __importDefault(require("./HttpClientResponse"));
 const Utils_1 = require("../Support/Utils");
 const form_data_1 = __importDefault(require("form-data"));
+const axios_retry_1 = __importDefault(require("axios-retry"));
 class HttpClient {
     constructor(axios, failureJudge = null, throwError = false) {
         this.axios = axios;
@@ -139,7 +140,11 @@ class HttpClient {
      * @returns
      */
     static create(config = null, failureJudge = null, throwError = false) {
-        return new HttpClient(axios_1.default.create(config), failureJudge, throwError);
+        let axios = axios_1.default.create(config);
+        if (config && config.retry) {
+            (0, axios_retry_1.default)(axios, config.retry);
+        }
+        return new HttpClient(axios, failureJudge, throwError);
     }
 }
 module.exports = HttpClient;

package/dist/Types/global.d.ts

@@ -74,6 +74,35 @@ export declare interface CacheFileConfig {
   ext: string
 }
 
+/**
+ * 网络请求配置
+ */
+export declare interface HttpConfig extends AxiosRequestConfig {
+  /**
+   * 是否抛出异常
+   */
+  throw?: boolean;
+  /**
+   * 是否抛出异常
+   * @see https://github.com/softonic/axios-retry#options
+   */
+  retry?: IAxiosRetry.IAxiosRetryConfig;
+  // retry?: {
+  //   /**
+  //    * 仅以下状态码重试
+  //    */
+  //   http_codes: number[];
+  //   /**
+  //    * 最大重试次数
+  //    */
+  //   max_retries: number;
+  //   /**
+  //    * 请求间隔 (毫秒)
+  //    */
+  //   delay: number;
+  // };
+}
+
 /**
  * 基础配置
  */
@@ -81,7 +110,7 @@ export declare interface BaseConfig {
   /**
    * 网络请求相关配置
    */
-  http?: AxiosRequestConfig;
+  http?: HttpConfig;
 
   /**
    * 文件缓存相关配置

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-easywechat",
-  "version": "3.1.0",
+  "version": "3.1.1",
   "description": "EasyWechat SDK for Node.js (NOT OFFICIAL)",
   "main": "dist/index.js",
   "scripts": {
@@ -22,11 +22,12 @@
     "@types/node": "^17.0.23",
     "axios-mock-adapter": "^1.21.1",
     "mocha": "^9.2.2",
-    "package-release": "^1.0.2",
+    "package-release": "^1.0.3",
     "typescript": "^4.6.3"
   },
   "dependencies": {
     "axios": "^0.26.1",
+    "axios-retry": "^3.3.1",
     "form-data": "^4.0.0",
     "merge": "^2.1.1",
     "node-socialite": "^1.2.5",