mhy-http-ts 1.0.0 → 1.0.2

package/README.md

@@ -3,7 +3,7 @@
 ---
 
 ```
-npm install @types/f-axios
+npm install mhy-http-ts
 ```
 
 # Usage
@@ -12,9 +12,9 @@ npm install @types/f-axios
 
 ```
 import type { AxiosRequestConfig, AxiosResponse, AxiosInstance } from 'axios';
-import { MethodEnum, ContentTypeEnum } from '@types/f-axios/enum';
+import { MethodEnum, ContentTypeEnum } from 'mhy-http-ts/enum';
 
-import { Create as AxiosCreate, Canceler as AxiosCanceler, Retry as AxiosRetry } from '@types/f-axios';
+import { Create as AxiosCreate, Canceler as AxiosCanceler, Retry as AxiosRetry } from 'mhy-http-ts';
 
 const defaultRequestConfig: any = {
 	baseURL: '/api',
@@ -63,7 +63,9 @@ const defaultInterceptors: any = {
 		return code ? Promise.resolve(data) : Promise.reject(data);
 	},
 
-	requestCatchHook: (error: AxiosError, config: AxiosRequestConfig) => { ... }
+	requestCatchHook: (error: Error | AxiosError, config: AxiosRequestConfig) => {
+		return Promise.reject(error)
+	 }
 }
 
 const defApi = new AxiosCreate(defaultRequestConfig, defaultInterceptors);
@@ -72,9 +74,11 @@ const defApi = new AxiosCreate(defaultRequestConfig, defaultInterceptors);
 # API
 
 ---
+
 ## get
 
 ---
+
 ```
 const getApi = defApi.get({
 	url: '/api/test/get',
@@ -86,6 +90,7 @@ const getApi = defApi.get({
 ## post
 
 ---
+
 ```
 const postApi = defApi.post({
 	url: '/api/test/post',
@@ -103,6 +108,7 @@ const download = defApi.post({
 ## put
 
 ---
+
 ```
 const putApi = defApi.post({
 	url: '/api/test/put',
@@ -114,6 +120,7 @@ const putApi = defApi.post({
 ## delete
 
 ---
+
 ```
 const deleteApi = defApi.post({
 	url: '/api/test/delete',
@@ -125,4 +132,5 @@ const deleteApi = defApi.post({
 # License
 
 ---
-MIT
+
+MIT

package/lib/abstract/InterceptorsHook.ts

@@ -11,7 +11,7 @@ export abstract class InterceptorsHook {
   /**
    * @description 请求拦截器异常处理
    */
-  requestInterceptorsCatch?: (error: AxiosError | Error) => void
+  requestInterceptorsCatch?: (error: any) => void
   /** 
    * @description 响应拦截器设置
   */
@@ -19,5 +19,5 @@ export abstract class InterceptorsHook {
   /** 
    * @description 响应拦截器异常处理
   */
-  responseInterceptorsCatch?: (error: AxiosError | Error, instance: AxiosInstance) => void
+  responseInterceptorsCatch?: (error: any, instance: AxiosInstance) => void
 }

package/lib/abstract/RequestHook.ts

@@ -1,4 +1,4 @@
-import type { AxiosRequestConfig, AxiosResponse } from 'axios'
+import type { AxiosError, AxiosRequestConfig, AxiosResponse } from 'axios'
 
 /**
  * @description
@@ -15,5 +15,5 @@ export abstract class RequestHook {
   /**
    * @description 请求异常处理
    */
-  requestCatchHook?: (error: Error, options?: any) => Promise<any>
+  requestCatchHook?: (error: Error | AxiosError, options?: any) => Promise<any>
 }

package/lib/class/Creator.ts

@@ -3,6 +3,8 @@ import { RequestHook } from '../abstract/RequestHook';
 import { InterceptorsHook } from '../abstract/InterceptorsHook';
 import { cloneDeep as _cloneDeep, isFunction as _isFunction } from 'lodash'
 import { MethodEnum } from "../enum"
+import { Canceler } from "./Canceler"
+import { RequestConfig } from "../interface"
 
 /**
  * @description axios创建
@@ -11,11 +13,11 @@ export class Create {
   // ⬇️ axios实例
   private instance: AxiosInstance
   // ⬇️ axios配置
-  private readonly requestConfig: AxiosRequestConfig
+  private readonly requestConfig: RequestConfig
   // ⬇️ 自定义拦截器
   private customInterceptors: RequestHook & InterceptorsHook
   // ⬇️ 构造器
-  constructor(requestConfig: AxiosRequestConfig, customInterceptors: RequestHook & InterceptorsHook) {
+  constructor(requestConfig: RequestConfig, customInterceptors: RequestHook & InterceptorsHook) {
     this.requestConfig = requestConfig // ⬅️ 配置参数
     this.customInterceptors = customInterceptors // ⬅️ 配置自定义拦截器
 
@@ -24,16 +26,16 @@ export class Create {
   }
   /**
    * @description 实例创建
-   * @param config AxiosRequestConfig
+   * @param config RequestConfig
    */
-  private createAxios(config: AxiosRequestConfig): void {
+  private createAxios(config: RequestConfig): void {
     this.instance = axios.create(config)
   }
   /**
    * @description 重新设置实例
-   * @param config AxiosRequestConfig
+   * @param config RequestConfig
    */
-  resetAxios(config: AxiosRequestConfig) {
+  resetAxios(config: RequestConfig) {
     if (!this.instance) return
     return this.createAxios(config)
   }
@@ -61,15 +63,18 @@ export class Create {
       responseInterceptors, // ⬅️ 响应拦截器设置
       responseInterceptorsCatch, // ⬅️ 响应拦截器异常处理
     } = this.customInterceptors || {}
+    const axiosCanceler = new Canceler();
     // 请求拦截器
     this.instance.interceptors.request.use(
       (config: InternalAxiosRequestConfig) => {
+        const isAllowRepeat = this.requestConfig?.customOptions?.isAllowRepeat ?? true
+        !isAllowRepeat && axiosCanceler.addPending(config)
         if (requestInterceptors && _isFunction(requestInterceptors)) {
-          config = requestInterceptors(config)
+          config = requestInterceptors(config, this.requestConfig)
         }
         return config
       },
-      (error: AxiosError | Error) => {
+      (error: any) => {
         requestInterceptorsCatch
           && _isFunction(requestInterceptorsCatch)
           && requestInterceptorsCatch(error)
@@ -78,76 +83,83 @@ export class Create {
     // 响应拦截器
     this.instance.interceptors.response.use(
       (res: AxiosResponse<any>) => {
+        res && axiosCanceler.removePending(res.config)
         if (responseInterceptors && _isFunction(responseInterceptors)) {
           res = responseInterceptors(res)
         }
         return res
       },
-      (error: AxiosError | Error) => {
+      (error: any) => {
         responseInterceptorsCatch
           && _isFunction(responseInterceptorsCatch)
-          && responseInterceptorsCatch(this.instance, error)
+          && responseInterceptorsCatch(error, this.instance)
       }
     )
   }
   /**
    * @description 通用请求
-   * @param config AxiosRequestConfig
+   * @param config RequestConfig
    */
-  request<T = any>(config: AxiosRequestConfig): Promise<T> {
-    let conf: AxiosRequestConfig = _cloneDeep(config)
+  request<T = any>(config: RequestConfig): Promise<T> {
+    let conf: RequestConfig = _cloneDeep(config)
     const { beforeRequestHook, afterRequestHook, requestCatchHook } = this.customInterceptors || {}
     if (beforeRequestHook && _isFunction(beforeRequestHook)) {
       conf = beforeRequestHook(conf)
     }
     return new Promise((resolve, reject) => {
-      this.instance.request<any, AxiosResponse<any>>(conf)
+      this.instance
+        .request<any, AxiosResponse<any>>(conf)
         .then((res: AxiosResponse<any>) => {
           if (afterRequestHook && _isFunction(afterRequestHook)) {
             try {
               resolve(afterRequestHook(res))
-            } catch (e) {
+              return
+            } catch (e: any) {
               reject(e || new Error('request has error'))
             }
           } else {
             resolve(res as unknown as Promise<T>)
           }
         })
-        .catch((error: AxiosError | Error) => {
-          requestCatchHook && _isFunction(requestCatchHook) ? reject(requestCatchHook(error, conf)) : reject(error)
+        .catch((error: Error | AxiosError) => {
+          if (requestCatchHook && _isFunction(requestCatchHook)) {
+            reject(requestCatchHook(error, conf))
+            return
+          }
+          reject(error)
         })
     })
   }
   /**
    * @description get请求
-   * @param config AxiosRequestConfig
+   * @param config RequestConfig
    * @returns Promise
    */
-  get<T = any>(config: AxiosRequestConfig): Promise<T> {
+  get<T = any>(config: RequestConfig): Promise<T> {
     return this.request({ ...config, method: MethodEnum.GET })
   }
   /**
    * @description post请求
-   * @param config AxiosRequestConfig
+   * @param config RequestConfig
    * @returns Promise
    */
-  post<T = any>(config: AxiosRequestConfig): Promise<T> {
+  post<T = any>(config: RequestConfig): Promise<T> {
     return this.request({ ...config, method: MethodEnum.POST })
   }
   /**
    * @description put请求
-   * @param config AxiosRequestConfig
+   * @param config RequestConfig
    * @returns Promise
    */
-  put<T = any>(config: AxiosRequestConfig): Promise<T> {
+  put<T = any>(config: RequestConfig): Promise<T> {
     return this.request({ ...config, method: MethodEnum.PUT })
   }
   /**
    * @description delete请求
-   * @param config AxiosRequestConfig
+   * @param config RequestConfig
    * @returns Promise
    */
-  delete<T = any>(config: AxiosRequestConfig): Promise<T> {
+  delete<T = any>(config: RequestConfig): Promise<T> {
     return this.request({ ...config, method: MethodEnum.DELETE })
   }
 }

package/lib/interface/index.ts

@@ -0,0 +1,13 @@
+import { AxiosRequestConfig } from "axios"
+
+export interface RequestConfig extends AxiosRequestConfig {
+	customOptions?: CustomOptions
+}
+
+export interface CustomOptions {
+	// 是否需要token
+	isAuthorized?: boolean
+	// 是否允许重复请求
+	isAllowRepeat?: boolean
+
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mhy-http-ts",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "基于ts的axios二次封装",
   "main": "./index.ts",
   "repository": "https://gitee.com/long-leg-kirky/mhy-http-ts",