@whitesev/utils 1.4.8 → 1.5.0

package/dist/src/Httpx.d.ts

@@ -1140,6 +1140,10 @@ declare class Httpx {
              * @param id 通过use返回的id
              */
             eject(id: string): boolean;
+            /**
+             * 移除所有拦截器
+             */
+            ejectAll(): void;
         };
         /**
          * 响应拦截器
@@ -1153,12 +1157,20 @@ declare class Httpx {
              * @param errorFn 设置的响应后回调函数，如果返回响应，则使用返回的响应，如果返回null|undefined，则阻止响应
              * + 超出 2xx 范围的状态码都会触发该函数
              */
-            use(successFn: () => void, errorFn: () => void): string | undefined;
+            use(successFn?: (response: HttpxAsyncResultData) => void, errorFn?: (data: {
+                type: "onerror" | "ontimeout" | "onabort";
+                error: Error;
+                response: any;
+            }) => void): string | undefined;
             /**
              * 移除拦截器
              * @param id 通过use返回的id
              */
             eject(id: string): boolean;
+            /**
+             * 移除所有拦截器
+             */
+            ejectAll(): void;
         };
     };
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@whitesev/utils",
-	"version": "1.4.8",
+	"version": "1.5.0",
 	"description": "一个常用的工具库",
 	"main": "dist/index.cjs.js",
 	"module": "dist/node/index.esm.js",

package/src/Httpx.ts

@@ -1247,7 +1247,7 @@ class Httpx {
 		/**
 		 * 添加请求前的回调处理配置
 		 */
-		addBeforeRequestCallBack(fn: Function) {
+		add(fn: Function) {
 			if (typeof fn === "function") {
 				let uuid = GenerateUUID();
 				this.$config.configList.push({
@@ -1265,7 +1265,7 @@ class Httpx {
 		 * 删除请求前的回调处理配置
 		 * @param id
 		 */
-		deleteBeforeRequestCallBack(id: string) {
+		delete(id: string) {
 			if (typeof id === "string") {
 				let findIndex = this.$config.configList.findIndex(
 					(item) => item.id === id
@@ -1280,7 +1280,7 @@ class Httpx {
 		/**
 		 * 清空设置的请求前的回调处理配置
 		 */
-		clearBeforeRequestCallBack() {
+		clearAll() {
 			this.$config.configList = [];
 		},
 	};
@@ -1292,8 +1292,8 @@ class Httpx {
 			configList: <
 				{
 					id: string;
-					successFn: Function;
-					errorFn: Function;
+					successFn?: Function;
+					errorFn?: Function;
 				}[]
 			>[],
 		},
@@ -1301,7 +1301,7 @@ class Httpx {
 		 * 成功的回调
 		 * @param response
 		 */
-		successResponseCallBack(response: any) {
+		successResponseCallBack(response: HttpxAsyncResultData) {
 			for (let index = 0; index < this.$config.configList.length; index++) {
 				let item = this.$config.configList[index];
 				if (typeof item.successFn === "function") {
@@ -1316,21 +1316,25 @@ class Httpx {
 		 * 失败的回调
 		 * @param response
 		 */
-		errorResponseCallBack(response: any) {
+		errorResponseCallBack(data: {
+			type: "onerror" | "ontimeout" | "onabort";
+			error: Error;
+			response: any;
+		}) {
 			for (let index = 0; index < this.$config.configList.length; index++) {
 				let item = this.$config.configList[index];
 				if (typeof item.errorFn === "function") {
-					if (item.errorFn(response) == null) {
+					if (item.errorFn(data) == null) {
 						return;
 					}
 				}
 			}
-			return response;
+			return data;
 		},
 		/**
 		 * 添加请求前的回调处理配置
 		 */
-		addAfterResponseCallBack(successFn: Function, errorFn: Function) {
+		add(successFn?: Function, errorFn?: Function) {
 			let id = GenerateUUID();
 			this.$config.configList.push({
 				id: id,
@@ -1343,7 +1347,7 @@ class Httpx {
 		 * 删除请求前的回调处理配置
 		 * @param id
 		 */
-		deleteAfterResponseCallBack(id: string) {
+		delete(id: string) {
 			if (typeof id === "string") {
 				let findIndex = this.$config.configList.findIndex(
 					(item) => item.id === id
@@ -1358,7 +1362,7 @@ class Httpx {
 		/**
 		 * 清空设置的请求前的回调处理配置
 		 */
-		clearAfterResponseCallBack() {
+		clearAll() {
 			this.$config.configList = [];
 		},
 	};
@@ -1617,6 +1621,15 @@ class Httpx {
 			} else if ("onabort" in this.context.#defaultDetails) {
 				this.context.#defaultDetails!.onabort!.apply(this, argumentsList);
 			}
+			if (
+				this.context.HttpxResponseHook.errorResponseCallBack({
+					type: "onabort",
+					error: new TypeError("request canceled"),
+					response: null,
+				}) == null
+			) {
+				return;
+			}
 			resolve({
 				status: false,
 				data: [...argumentsList],
@@ -1645,6 +1658,15 @@ class Httpx {
 			if (response.length) {
 				response = response[0];
 			}
+			if (
+				this.context.HttpxResponseHook.errorResponseCallBack({
+					type: "onerror",
+					error: new TypeError("request error"),
+					response: response,
+				}) == null
+			) {
+				return;
+			}
 			resolve({
 				status: false,
 				data: response,
@@ -1669,6 +1691,16 @@ class Httpx {
 			} else if ("ontimeout" in this.context.#defaultDetails) {
 				this.context.#defaultDetails!.ontimeout!.apply(this, argumentsList);
 			}
+
+			if (
+				this.context.HttpxResponseHook.errorResponseCallBack({
+					type: "ontimeout",
+					error: new TypeError("request timeout"),
+					response: (argumentsList || [null])[0],
+				}) == null
+			) {
+				return;
+			}
 			resolve({
 				status: false,
 				data: [...argumentsList],
@@ -1755,8 +1787,15 @@ class Httpx {
 			) {
 				Response["finalUrl"] = (Response as any)["responseURL"];
 			}
+
 			/* 状态码2xx都是成功的 */
 			if (Math.floor(Response.status / 100) === 2) {
+				if (
+					this.context.HttpxResponseHook.successResponseCallBack(Response) ==
+					null
+				) {
+					return;
+				}
 				resolve({
 					status: true,
 					data: Response,
@@ -2038,14 +2077,24 @@ class Httpx {
 			 * @param fn 设置的请求前回调函数，如果返回配置，则使用返回的配置，如果返回null|undefined，则阻止请求
 			 */
 			use(fn: (details: Required<HttpxDetails>) => void) {
-				return this.context.HttpxRequestHook.addBeforeRequestCallBack(fn);
+				if (typeof fn !== "function") {
+					console.warn("[Httpx-interceptors-request] 请传入拦截器函数");
+					return;
+				}
+				return this.context.HttpxRequestHook.add(fn);
 			},
 			/**
 			 * 移除拦截器
 			 * @param id 通过use返回的id
 			 */
 			eject(id: string) {
-				return this.context.HttpxRequestHook.deleteBeforeRequestCallBack(id);
+				return this.context.HttpxRequestHook.delete(id);
+			},
+			/**
+			 * 移除所有拦截器
+			 */
+			ejectAll() {
+				this.context.HttpxRequestHook.clearAll();
 			},
 		},
 		/**
@@ -2060,22 +2109,32 @@ class Httpx {
 			 * @param errorFn 设置的响应后回调函数，如果返回响应，则使用返回的响应，如果返回null|undefined，则阻止响应
 			 * + 超出 2xx 范围的状态码都会触发该函数
 			 */
-			use(successFn: () => void, errorFn: () => void) {
+			use(
+				successFn?: (response: HttpxAsyncResultData) => void,
+				errorFn?: (data: {
+					type: "onerror" | "ontimeout" | "onabort";
+					error: Error;
+					response: any;
+				}) => void
+			) {
 				if (typeof successFn !== "function" && typeof errorFn !== "function") {
-					console.warn("[Httpx] 请传入拦截器函数");
+					console.warn("[Httpx-interceptors-response] 必须传入一个拦截器函数");
 					return;
 				}
-				return this.context.HttpxResponseHook.addAfterResponseCallBack(
-					successFn,
-					errorFn
-				);
+				return this.context.HttpxResponseHook.add(successFn!, errorFn!);
 			},
 			/**
 			 * 移除拦截器
 			 * @param id 通过use返回的id
 			 */
 			eject(id: string) {
-				return this.context.HttpxResponseHook.deleteAfterResponseCallBack(id);
+				return this.context.HttpxResponseHook.delete(id);
+			},
+			/**
+			 * 移除所有拦截器
+			 */
+			ejectAll() {
+				this.context.HttpxResponseHook.clearAll();
 			},
 		},
 	};