@whitesev/utils 2.2.1 → 2.2.3

package/dist/types/src/Httpx.d.ts

@@ -1124,6 +1124,12 @@ export declare interface HttpxHookErrorData {
     error: Error;
     response: any;
 }
+export type HttpxPromise<T> = Promise<T> & {
+    /**
+     * 用于取消发送的请求，并执行resolve返回abort
+     */
+    abort(): void;
+};
 declare class Httpx {
     #private;
     private GM_Api;
@@ -1132,6 +1138,10 @@ declare class Httpx {
     private HttpxRequestDetails;
     private HttpxCallBack;
     private HttpxRequest;
+    /**
+     * 实例化，可传入GM_xmlhttpRequest，未传入则使用window.fetch
+     * @param __xmlHttpRequest__
+     */
     constructor(__xmlHttpRequest__?: any);
     /**
      * 覆盖全局配置
@@ -1195,69 +1205,69 @@ declare class Httpx {
     setXMLHttpRequest(httpRequest: any): void;
     /**
      * GET 请求
+     * @param url 网址
      * @param details 配置
      */
-    get<T extends HttpxDetails>(details: T): Promise<HttpxAsyncResult<T>>;
+    get<T extends HttpxDetails>(url: string, details: T): HttpxPromise<HttpxAsyncResult<T>>;
     /**
      * GET 请求
-     * @param url 网址
      * @param details 配置
      */
-    get<T extends HttpxDetails>(url: string, details: T): Promise<HttpxAsyncResult<T>>;
+    get<T extends HttpxDetails>(details: T): HttpxPromise<HttpxAsyncResult<T>>;
     /**
      * POST 请求
      * @param details 配置
      */
-    post<T extends HttpxDetails>(details: T): Promise<HttpxAsyncResult<T>>;
+    post<T extends HttpxDetails>(details: T): HttpxPromise<HttpxAsyncResult<T>>;
     /**
      * POST 请求
      * @param url 网址
      * @param details 配置
      */
-    post<T extends HttpxDetails>(url: string, details: T): Promise<HttpxAsyncResult<T>>;
+    post<T extends HttpxDetails>(url: string, details: T): HttpxPromise<HttpxAsyncResult<T>>;
     /**
      * HEAD 请求
      * @param details 配置
      */
-    head<T extends HttpxDetails>(details: T): Promise<HttpxAsyncResult<T>>;
+    head<T extends HttpxDetails>(details: T): HttpxPromise<HttpxAsyncResult<T>>;
     /**
      * HEAD 请求
      * @param url 网址
      * @param details 配置
      */
-    head<T extends HttpxDetails>(url: string, details: T): Promise<HttpxAsyncResult<T>>;
+    head<T extends HttpxDetails>(url: string, details: T): HttpxPromise<HttpxAsyncResult<T>>;
     /**
      * OPTIONS 请求
      * @param details 配置
      */
-    options<T extends HttpxDetails>(details: T): Promise<HttpxAsyncResult<T>>;
+    options<T extends HttpxDetails>(details: T): HttpxPromise<HttpxAsyncResult<T>>;
     /**
      * OPTIONS 请求
      * @param url 网址
      * @param details 配置
      */
-    options<T extends HttpxDetails>(url: string, details: T): Promise<HttpxAsyncResult<T>>;
+    options<T extends HttpxDetails>(url: string, details: T): HttpxPromise<HttpxAsyncResult<T>>;
     /**
      * DELETE 请求
      * @param details 配置
      */
-    delete<T extends HttpxDetails>(details: T): Promise<HttpxAsyncResult<T>>;
+    delete<T extends HttpxDetails>(details: T): HttpxPromise<HttpxAsyncResult<T>>;
     /**
      * DELETE 请求
      * @param url 网址
      * @param details 配置
      */
-    delete<T extends HttpxDetails>(url: string, details: T): Promise<HttpxAsyncResult<T>>;
+    delete<T extends HttpxDetails>(url: string, details: T): HttpxPromise<HttpxAsyncResult<T>>;
     /**
      * PUT 请求
      * @param details 配置
      */
-    put<T extends HttpxDetails>(details: T): Promise<HttpxAsyncResult<T>>;
+    put<T extends HttpxDetails>(details: T): HttpxPromise<HttpxAsyncResult<T>>;
     /**
      * PUT 请求
      * @param url 网址
      * @param details 配置
      */
-    put<T extends HttpxDetails>(url: string, details: T): Promise<HttpxAsyncResult<T>>;
+    put<T extends HttpxDetails>(url: string, details: T): HttpxPromise<HttpxAsyncResult<T>>;
 }
 export { Httpx };

package/dist/types/src/Utils.d.ts

@@ -320,7 +320,7 @@ declare class Utils {
      * Utils.formatTime()
      * > '2023-1-1 00:00:00'
      **/
-    formatTime(text?: string | number | Date, formatType?: "yyyy-MM-dd HH:mm:ss" | "yyyy/MM/dd HH:mm:ss" | "yyyy_MM_dd_HH_mm_ss" | "yyyy年MM月dd日 HH时mm分ss秒" | "yyyy年MM月dd日 hh:mm:ss" | "yyyy年MM月dd日 HH:mm:ss" | "yyyy-MM-dd" | "yyyyMMdd" | "HH:mm:ss"): string;
+    formatTime(text?: string | number | Date, formatType?: "yyyy-MM-dd HH:mm:ss" | "yyyy/MM/dd HH:mm:ss" | "yyyy_MM_dd_HH_mm_ss" | "yyyy年MM月dd日 HH时mm分ss秒" | "yyyy年MM月dd日 hh:mm:ss" | "yyyy年MM月dd日 HH:mm:ss" | "yyyy-MM-dd" | "yyyyMMdd" | "HH:mm:ss" | "yyyy" | "MM" | "dd" | "HH" | "mm" | "ss"): string;
     /**
      * 字符串格式的时间转时间戳
      * @param text	字符串格式的时间，例如：
@@ -1029,6 +1029,13 @@ declare class Utils {
          */
         callback: MutationCallback;
     }): MutationObserver;
+    /**
+     * 使用观察器观察元素出现在视图内，出现的话触发回调
+     * @param target 目标元素
+     * @param callback 触发的回调
+     * @param options 观察器配置
+     */
+    mutatuinVisible(target: Element | Element[], callback: (entries: IntersectionObserverEntry[], observer: IntersectionObserver) => void, options?: IntersectionObserverInit): void;
     /**
      * 去除全局window下的Utils，返回控制权
      * @example

package/package.json

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

package/src/Httpx.ts

@@ -1223,6 +1223,13 @@ export declare interface HttpxHookErrorData {
 	response: any;
 }
 
+export type HttpxPromise<T> = Promise<T> & {
+	/**
+	 * 用于取消发送的请求，并执行resolve返回abort
+	 */
+	abort(): void;
+};
+
 class Httpx {
 	private GM_Api = {
 		xmlHttpRequest: null as any,
@@ -2014,10 +2021,10 @@ class Httpx {
 			if (details.fetch) {
 				const { fetchDetails, fetchRequestInit, abortController } =
 					this.context.HttpxRequestDetails.handleFetchDetail(details);
-				this.fetch(fetchDetails, fetchRequestInit, abortController);
+				return this.fetch(fetchDetails, fetchRequestInit, abortController);
 			} else {
 				Reflect.deleteProperty(details, "fetchInit");
-				this.xmlHttpRequest(details);
+				return this.xmlHttpRequest(details);
 			}
 		},
 		/**
@@ -2025,7 +2032,7 @@ class Httpx {
 		 * @param details
 		 */
 		xmlHttpRequest(details: Required<HttpxDetails>) {
-			this.context.GM_Api.xmlHttpRequest(details);
+			return this.context.GM_Api.xmlHttpRequest(details);
 		},
 		/**
 		 * 使用fetch发送请求
@@ -2195,6 +2202,10 @@ class Httpx {
 	 * 当前使用请求时，输出请求的配置
 	 */
 	#LOG_DETAILS = false;
+	/**
+	 * 实例化，可传入GM_xmlhttpRequest，未传入则使用window.fetch
+	 * @param __xmlHttpRequest__
+	 */
 	constructor(__xmlHttpRequest__?: any) {
 		if (typeof __xmlHttpRequest__ !== "function") {
 			console.warn(
@@ -2306,44 +2317,68 @@ class Httpx {
 	}
 	/**
 	 * GET 请求
+	 * @param url 网址
 	 * @param details 配置
 	 */
-	async get<T extends HttpxDetails>(details: T): Promise<HttpxAsyncResult<T>>;
+	async get<T extends HttpxDetails>(
+		url: string,
+		details: T // @ts-ignore
+	): HttpxPromise<HttpxAsyncResult<T>>;
 	/**
 	 * GET 请求
-	 * @param url 网址
 	 * @param details 配置
 	 */
 	async get<T extends HttpxDetails>(
-		url: string,
-		details: T
-	): Promise<HttpxAsyncResult<T>>;
+		details: T // @ts-ignore
+	): HttpxPromise<HttpxAsyncResult<T>>;
 	/**
 	 * GET 请求
+	 * @param url 网址
+	 * @param details 配置
 	 */
 	async get(
-		...args: (HttpxDetails | string)[]
-	): Promise<HttpxAsyncResult<HttpxDetails>> {
-		let that = this;
+		...args: (HttpxDetails | string)[] // @ts-ignore
+	): HttpxPromise<HttpxAsyncResult<HttpxDetails>> {
 		let details = this.HttpxRequestDetails.handleBeforeRequestDetails(...args);
-
-		return new Promise((resolve, reject) => {
-			let requestDetails = that.HttpxRequestDetails.getDetails(
-				"GET",
-				details,
-				resolve,
-				reject
-			);
-			Reflect.deleteProperty(requestDetails, "onprogress");
-			(requestDetails as any) = that.HttpxRequestDetails.handle(requestDetails);
-			that.HttpxRequest.request(requestDetails);
+		let abortFn: Function | null = null;
+		const promise = new Promise<HttpxAsyncResult<HttpxDetails>>(
+			(resolve, reject) => {
+				let requestDetails = this.HttpxRequestDetails.getDetails(
+					"GET",
+					details,
+					resolve,
+					reject
+				);
+				Reflect.deleteProperty(requestDetails, "onprogress");
+				// @ts-ignore
+				requestDetails = this.HttpxRequestDetails.handle(requestDetails);
+				const requestResult = this.HttpxRequest.request(requestDetails);
+				if (
+					requestResult != null &&
+					typeof requestResult.abort === "function"
+				) {
+					abortFn = requestResult.abort;
+				}
+			}
+		);
+		Object.defineProperty(promise, "abort", {
+			value: () => {
+				return () => {
+					if (typeof abortFn === "function") {
+						abortFn();
+					}
+				};
+			},
 		});
+		return promise;
 	}
 	/**
 	 * POST 请求
 	 * @param details 配置
 	 */
-	async post<T extends HttpxDetails>(details: T): Promise<HttpxAsyncResult<T>>;
+	async post<T extends HttpxDetails>(
+		details: T // @ts-ignore
+	): HttpxPromise<HttpxAsyncResult<T>>;
 	/**
 	 * POST 请求
 	 * @param url 网址
@@ -2351,33 +2386,53 @@ class Httpx {
 	 */
 	async post<T extends HttpxDetails>(
 		url: string,
-		details: T
-	): Promise<HttpxAsyncResult<T>>;
+		details: T // @ts-ignore
+	): HttpxPromise<HttpxAsyncResult<T>>;
 	/**
 	 * POST 请求
 	 */
 	async post(
-		...args: (HttpxDetails | string)[]
-	): Promise<HttpxAsyncResult<HttpxDetails>> {
-		let that = this;
+		...args: (HttpxDetails | string)[] // @ts-ignore
+	): HttpxPromise<HttpxAsyncResult<HttpxDetails>> {
 		let details = this.HttpxRequestDetails.handleBeforeRequestDetails(...args);
-
-		return new Promise((resolve, reject) => {
-			let requestDetails = that.HttpxRequestDetails.getDetails(
-				"POST",
-				details,
-				resolve,
-				reject
-			);
-			(requestDetails as any) = that.HttpxRequestDetails.handle(requestDetails);
-			that.HttpxRequest.request(requestDetails);
+		let abortFn: Function | null = null;
+		const promise = new Promise<HttpxAsyncResult<HttpxDetails>>(
+			(resolve, reject) => {
+				let requestDetails = this.HttpxRequestDetails.getDetails(
+					"POST",
+					details,
+					resolve,
+					reject
+				);
+				// @ts-ignore
+				requestDetails = this.HttpxRequestDetails.handle(requestDetails);
+				const requestResult = this.HttpxRequest.request(requestDetails);
+				if (
+					requestResult != null &&
+					typeof requestResult.abort === "function"
+				) {
+					abortFn = requestResult.abort;
+				}
+			}
+		);
+		Object.defineProperty(promise, "abort", {
+			value: () => {
+				return () => {
+					if (typeof abortFn === "function") {
+						abortFn();
+					}
+				};
+			},
 		});
+		return promise;
 	}
 	/**
 	 * HEAD 请求
 	 * @param details 配置
 	 */
-	async head<T extends HttpxDetails>(details: T): Promise<HttpxAsyncResult<T>>;
+	async head<T extends HttpxDetails>(
+		details: T // @ts-ignore
+	): HttpxPromise<HttpxAsyncResult<T>>;
 	/**
 	 * HEAD 请求
 	 * @param url 网址
@@ -2385,35 +2440,58 @@ class Httpx {
 	 */
 	async head<T extends HttpxDetails>(
 		url: string,
-		details: T
-	): Promise<HttpxAsyncResult<T>>;
+		details: T // @ts-ignore
+	): HttpxPromise<HttpxAsyncResult<T>>;
 	/**
 	 * HEAD 请求
 	 */
 	async head(
-		...args: (HttpxDetails | string)[]
-	): Promise<HttpxAsyncResult<HttpxDetails>> {
-		let that = this;
+		...args: (HttpxDetails | string)[] // @ts-ignore
+	): HttpxPromise<HttpxAsyncResult<HttpxDetails>> {
 		let details = this.HttpxRequestDetails.handleBeforeRequestDetails(...args);
+		let abortFn: Function | null = null;
 
-		return new Promise((resolve, reject) => {
-			let requestDetails = that.HttpxRequestDetails.getDetails(
-				"HEAD",
-				details,
-				resolve,
-				reject
-			);
-			Reflect.deleteProperty(requestDetails, "onprogress");
-			(requestDetails as any) = that.HttpxRequestDetails.handle(requestDetails);
-			that.HttpxRequest.request(requestDetails);
+		const promise = new Promise<HttpxAsyncResult<HttpxDetails>>(
+			(resolve, reject) => {
+				let requestDetails = this.HttpxRequestDetails.getDetails(
+					"HEAD",
+					details,
+					resolve,
+					reject
+				);
+				Reflect.deleteProperty(requestDetails, "onprogress");
+				// @ts-ignore
+				requestDetails = this.HttpxRequestDetails.handle(requestDetails);
+				const requestResult = this.HttpxRequest.request(requestDetails);
+				if (
+					requestResult != null &&
+					typeof requestResult.abort === "function"
+				) {
+					abortFn = requestResult.abort;
+				}
+			}
+		);
+
+		Object.defineProperty(promise, "abort", {
+			value: () => {
+				return () => {
+					if (typeof abortFn === "function") {
+						abortFn();
+					}
+				};
+			},
 		});
+
+		return promise;
 	}
 
 	/**
 	 * OPTIONS 请求
 	 * @param details 配置
 	 */
-	options<T extends HttpxDetails>(details: T): Promise<HttpxAsyncResult<T>>;
+	options<T extends HttpxDetails>(
+		details: T // @ts-ignore
+	): HttpxPromise<HttpxAsyncResult<T>>;
 	/**
 	 * OPTIONS 请求
 	 * @param url 网址
@@ -2421,28 +2499,46 @@ class Httpx {
 	 */
 	options<T extends HttpxDetails>(
 		url: string,
-		details: T
-	): Promise<HttpxAsyncResult<T>>;
+		details: T // @ts-ignore
+	): HttpxPromise<HttpxAsyncResult<T>>;
 	/**
 	 * OPTIONS 请求
 	 */
 	async options(
-		...args: (HttpxDetails | string)[]
-	): Promise<HttpxAsyncResult<HttpxDetails>> {
-		let that = this;
+		...args: (HttpxDetails | string)[] // @ts-ignore
+	): HttpxPromise<HttpxAsyncResult<HttpxDetails>> {
 		let details = this.HttpxRequestDetails.handleBeforeRequestDetails(...args);
-
-		return new Promise((resolve, reject) => {
-			let requestDetails = that.HttpxRequestDetails.getDetails(
-				"OPTIONS",
-				details,
-				resolve,
-				reject
-			);
-			Reflect.deleteProperty(requestDetails, "onprogress");
-			(requestDetails as any) = that.HttpxRequestDetails.handle(requestDetails);
-			that.HttpxRequest.request(requestDetails);
+		let abortFn: Function | null = null;
+		const promise = new Promise<HttpxAsyncResult<HttpxDetails>>(
+			(resolve, reject) => {
+				let requestDetails = this.HttpxRequestDetails.getDetails(
+					"OPTIONS",
+					details,
+					resolve,
+					reject
+				);
+				Reflect.deleteProperty(requestDetails, "onprogress");
+				// @ts-ignore
+				requestDetails = this.HttpxRequestDetails.handle(requestDetails);
+				const requestResult = this.HttpxRequest.request(requestDetails);
+				if (
+					requestResult != null &&
+					typeof requestResult.abort === "function"
+				) {
+					abortFn = requestResult.abort;
+				}
+			}
+		);
+		Object.defineProperty(promise, "abort", {
+			value: () => {
+				return () => {
+					if (typeof abortFn === "function") {
+						abortFn();
+					}
+				};
+			},
 		});
+		return promise;
 	}
 
 	/**
@@ -2450,8 +2546,8 @@ class Httpx {
 	 * @param details 配置
 	 */
 	async delete<T extends HttpxDetails>(
-		details: T
-	): Promise<HttpxAsyncResult<T>>;
+		details: T // @ts-ignore
+	): HttpxPromise<HttpxAsyncResult<T>>;
 	/**
 	 * DELETE 请求
 	 * @param url 网址
@@ -2459,35 +2555,56 @@ class Httpx {
 	 */
 	async delete<T extends HttpxDetails>(
 		url: string,
-		details: T
-	): Promise<HttpxAsyncResult<T>>;
+		details: T // @ts-ignore
+	): HttpxPromise<HttpxAsyncResult<T>>;
 	/**
 	 * DELETE 请求
 	 */
 	async delete(
-		...args: (HttpxDetails | string)[]
-	): Promise<HttpxAsyncResult<HttpxDetails>> {
-		let that = this;
+		...args: (HttpxDetails | string)[] // @ts-ignore
+	): HttpxPromise<HttpxAsyncResult<HttpxDetails>> {
 		let details = this.HttpxRequestDetails.handleBeforeRequestDetails(...args);
+		let abortFn: Function | null = null;
+		const promise = new Promise<HttpxAsyncResult<HttpxDetails>>(
+			(resolve, reject) => {
+				let requestDetails = this.HttpxRequestDetails.getDetails(
+					"DELETE",
+					details,
+					resolve,
+					reject
+				);
+				Reflect.deleteProperty(requestDetails, "onprogress");
+				// @ts-ignore
+				requestDetails = this.HttpxRequestDetails.handle(requestDetails);
+				const requestResult = this.HttpxRequest.request(requestDetails);
+				if (
+					requestResult != null &&
+					typeof requestResult.abort === "function"
+				) {
+					abortFn = requestResult.abort;
+				}
+			}
+		);
 
-		return new Promise((resolve, reject) => {
-			let requestDetails = that.HttpxRequestDetails.getDetails(
-				"DELETE",
-				details,
-				resolve,
-				reject
-			);
-			Reflect.deleteProperty(requestDetails, "onprogress");
-			(requestDetails as any) = that.HttpxRequestDetails.handle(requestDetails);
-			that.HttpxRequest.request(requestDetails);
+		Object.defineProperty(promise, "abort", {
+			value: () => {
+				return () => {
+					if (typeof abortFn === "function") {
+						abortFn();
+					}
+				};
+			},
 		});
+		return promise;
 	}
 
 	/**
 	 * PUT 请求
 	 * @param details 配置
 	 */
-	async put<T extends HttpxDetails>(details: T): Promise<HttpxAsyncResult<T>>;
+	async put<T extends HttpxDetails>(
+		details: T // @ts-ignore
+	): HttpxPromise<HttpxAsyncResult<T>>;
 	/**
 	 * PUT 请求
 	 * @param url 网址
@@ -2495,27 +2612,45 @@ class Httpx {
 	 */
 	async put<T extends HttpxDetails>(
 		url: string,
-		details: T
-	): Promise<HttpxAsyncResult<T>>;
+		details: T // @ts-ignore
+	): HttpxPromise<HttpxAsyncResult<T>>;
 	/**
 	 * PUT 请求
 	 */
 	async put(
-		...args: (HttpxDetails | string)[]
-	): Promise<HttpxAsyncResult<HttpxDetails>> {
-		let that = this;
+		...args: (HttpxDetails | string)[] // @ts-ignore
+	): HttpxPromise<HttpxAsyncResult<HttpxDetails>> {
 		let details = this.HttpxRequestDetails.handleBeforeRequestDetails(...args);
-
-		return new Promise((resolve, reject) => {
-			let requestDetails = that.HttpxRequestDetails.getDetails(
-				"PUT",
-				details,
-				resolve,
-				reject
-			);
-			(requestDetails as any) = that.HttpxRequestDetails.handle(requestDetails);
-			that.HttpxRequest.request(requestDetails);
+		let abortFn: Function | null = null;
+		const promise = new Promise<HttpxAsyncResult<HttpxDetails>>(
+			(resolve, reject) => {
+				let requestDetails = this.HttpxRequestDetails.getDetails(
+					"PUT",
+					details,
+					resolve,
+					reject
+				);
+				// @ts-ignore
+				requestDetails = this.HttpxRequestDetails.handle(requestDetails);
+				const requestResult = this.HttpxRequest.request(requestDetails);
+				if (
+					requestResult != null &&
+					typeof requestResult.abort === "function"
+				) {
+					abortFn = requestResult.abort;
+				}
+			}
+		);
+		Object.defineProperty(promise, "abort", {
+			value: () => {
+				return () => {
+					if (typeof abortFn === "function") {
+						abortFn();
+					}
+				};
+			},
 		});
+		return promise;
 	}
 }