@whitesev/utils 2.6.5 → 2.6.6

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

@@ -1,176 +1,176 @@
-import type { HttpxHookErrorData, HttpxRequestOption, HttpxRequestOptionConfig, HttpxResponse, HttpxResponseData, HttpxPromise } from "./types/Httpx";
-declare class Httpx {
-    #private;
-    private GM_Api;
-    private HttpxRequestHook;
-    private HttpxResponseHook;
-    private HttpxRequestOption;
-    private HttpxCallBack;
-    private HttpxRequest;
-    /**
-     * 实例化，可传入GM_xmlhttpRequest，未传入则使用window.fetch
-     * @param xmlHttpRequest
-     */
-    constructor(xmlHttpRequest?: Function);
-    /**
-     * 覆盖全局配置
-     * @param details 配置
-     */
-    config(details?: Partial<HttpxRequestOptionConfig>): void;
-    /**
-     * 拦截器
-     */
-    interceptors: {
-        /**
-         * 请求拦截器
-         */
-        request: {
-            context: Httpx;
-            /**
-             * 添加拦截器
-             * @param fn 设置的请求前回调函数，如果返回配置，则使用返回的配置，如果返回null|undefined，则阻止请求
-             */
-            use(fn: <T extends Required<HttpxRequestOption>>(details: T) => void | T | Promise<void | T>): string | undefined;
-            /**
-             * 移除拦截器
-             * @param id 通过use返回的id
-             */
-            eject(id: string): boolean;
-            /**
-             * 移除所有拦截器
-             */
-            ejectAll(): void;
-        };
-        /**
-         * 响应拦截器
-         */
-        response: {
-            context: Httpx;
-            /**
-             * 添加拦截器
-             * @param successFn 设置的响应后回调函数，如果返回响应，则使用返回的响应，如果返回null|undefined，则阻止响应
-             * + 2xx 范围内的状态码都会触发该函数
-             * @param errorFn 设置的响应后回调函数，如果返回响应，则使用返回的响应，如果返回null|undefined，则阻止响应
-             * + 超出 2xx 范围的状态码都会触发该函数
-             */
-            use(successFn?: <T extends HttpxResponseData<HttpxRequestOption>>(response: T, details: HttpxRequestOption) => void | T, errorFn?: <T extends HttpxHookErrorData>(data: T) => void | T | Promise<void | T>): string | undefined;
-            /**
-             * 移除拦截器
-             * @param id 通过use返回的id
-             */
-            eject(id: string): boolean;
-            /**
-             * 移除所有拦截器
-             */
-            ejectAll(): void;
-        };
-    };
-    /**
-     * 修改xmlHttpRequest
-     * @param httpRequest 网络请求函数
-     */
-    setXMLHttpRequest(httpRequest: Function): void;
-    /**
-     * GET 请求
-     * @param url 网址
-     */
-    get<T extends HttpxRequestOption>(url: string): HttpxPromise<HttpxResponse<T>>;
-    /**
-     * GET 请求
-     * @param details 配置
-     */
-    get<T extends HttpxRequestOption>(details: T): HttpxPromise<HttpxResponse<T>>;
-    /**
-     * GET 请求
-     * @param url 网址
-     * @param details 配置
-     */
-    get<T extends HttpxRequestOption>(url: string, details: T): HttpxPromise<HttpxResponse<T>>;
-    /**
-     * POST 请求
-     * @param details 配置
-     */
-    post<T extends HttpxRequestOption>(details: T): HttpxPromise<HttpxResponse<T>>;
-    /**
-     * POST 请求
-     * @param url 网址
-     */
-    post<T extends HttpxRequestOption>(url: string): HttpxPromise<HttpxResponse<T>>;
-    /**
-     * POST 请求
-     * @param url 网址
-     * @param details 配置
-     */
-    post<T extends HttpxRequestOption>(url: string, details: T): HttpxPromise<HttpxResponse<T>>;
-    /**
-     * HEAD 请求
-     * @param details 配置
-     */
-    head<T extends HttpxRequestOption>(details: T): HttpxPromise<HttpxResponse<T>>;
-    /**
-     * HEAD 请求
-     * @param url 网址
-     */
-    head<T extends HttpxRequestOption>(url: string): HttpxPromise<HttpxResponse<T>>;
-    /**
-     * HEAD 请求
-     * @param url 网址
-     * @param details 配置
-     */
-    head<T extends HttpxRequestOption>(url: string, details: T): HttpxPromise<HttpxResponse<T>>;
-    /**
-     * OPTIONS 请求
-     * @param details 配置
-     */
-    options<T extends HttpxRequestOption>(details: T): HttpxPromise<HttpxResponse<T>>;
-    /**
-     * OPTIONS 请求
-     * @param url 网址
-     */
-    options<T extends HttpxRequestOption>(url: string): HttpxPromise<HttpxResponse<T>>;
-    /**
-     * OPTIONS 请求
-     * @param url 网址
-     * @param details 配置
-     */
-    options<T extends HttpxRequestOption>(url: string, details: T): HttpxPromise<HttpxResponse<T>>;
-    /**
-     * DELETE 请求
-     * @param details 配置
-     */
-    delete<T extends HttpxRequestOption>(details: T): HttpxPromise<HttpxResponse<T>>;
-    /**
-     * DELETE 请求
-     * @param url 网址
-     */
-    delete<T extends HttpxRequestOption>(url: string): HttpxPromise<HttpxResponse<T>>;
-    /**
-     * DELETE 请求
-     * @param url 网址
-     * @param details 配置
-     */
-    delete<T extends HttpxRequestOption>(url: string, details: T): HttpxPromise<HttpxResponse<T>>;
-    /**
-     * PUT 请求
-     * @param details 配置
-     */
-    put<T extends HttpxRequestOption>(details: T): HttpxPromise<HttpxResponse<T>>;
-    /**
-     * PUT 请求
-     * @param url 网址
-     */
-    put<T extends HttpxRequestOption>(url: string): HttpxPromise<HttpxResponse<T>>;
-    /**
-     * PUT 请求
-     * @param url 网址
-     * @param details 配置
-     */
-    put<T extends HttpxRequestOption>(url: string, details: T): HttpxPromise<HttpxResponse<T>>;
-    /**
-     * 发送请求
-     * @param details 配置
-     * @param beforeRequestOption 处理请求前的配置
-     */
-    request<T extends HttpxRequestOption>(details: T, beforeRequestOption?: (option: Required<T>) => void): HttpxPromise<HttpxResponse<T>>;
-}
-export { Httpx };
+import type { HttpxHookErrorData, HttpxRequestOption, HttpxResponse, HttpxResponseData, HttpxPromise, HttpxInitOption } from "./types/Httpx";
+declare class Httpx {
+    #private;
+    private GM_Api;
+    private HttpxRequestHook;
+    private HttpxResponseHook;
+    private HttpxRequestOption;
+    private HttpxCallBack;
+    private HttpxRequest;
+    /**
+     * 实例化
+     * @param option 初始化配置
+     */
+    constructor(option?: Partial<HttpxInitOption>);
+    /**
+     * 覆盖当前配置
+     * @param option
+     */
+    config(option?: Partial<HttpxInitOption>): void;
+    /**
+     * 拦截器
+     */
+    interceptors: {
+        /**
+         * 请求拦截器
+         */
+        request: {
+            context: Httpx;
+            /**
+             * 添加拦截器
+             * @param fn 设置的请求前回调函数，如果返回配置，则使用返回的配置，如果返回null|undefined，则阻止请求
+             */
+            use(fn: <T extends Required<HttpxRequestOption>>(details: T) => void | T | Promise<void | T>): string | undefined;
+            /**
+             * 移除拦截器
+             * @param id 通过use返回的id
+             */
+            eject(id: string): boolean;
+            /**
+             * 移除所有拦截器
+             */
+            ejectAll(): void;
+        };
+        /**
+         * 响应拦截器
+         */
+        response: {
+            context: Httpx;
+            /**
+             * 添加拦截器
+             * @param successFn 设置的响应后回调函数，如果返回响应，则使用返回的响应，如果返回null|undefined，则阻止响应
+             * + 2xx 范围内的状态码都会触发该函数
+             * @param errorFn 设置的响应后回调函数，如果返回响应，则使用返回的响应，如果返回null|undefined，则阻止响应
+             * + 超出 2xx 范围的状态码都会触发该函数
+             */
+            use(successFn?: <T extends HttpxResponseData<HttpxRequestOption>>(response: T, details: HttpxRequestOption) => void | T, errorFn?: <T extends HttpxHookErrorData>(data: T) => void | T | Promise<void | T>): string | undefined;
+            /**
+             * 移除拦截器
+             * @param id 通过use返回的id
+             */
+            eject(id: string): boolean;
+            /**
+             * 移除所有拦截器
+             */
+            ejectAll(): void;
+        };
+    };
+    /**
+     * 修改xmlHttpRequest
+     * @param httpRequest 网络请求函数
+     */
+    setXMLHttpRequest(httpRequest: Function): void;
+    /**
+     * GET 请求
+     * @param url 网址
+     */
+    get<T extends HttpxRequestOption>(url: string): HttpxPromise<HttpxResponse<T>>;
+    /**
+     * GET 请求
+     * @param details 配置
+     */
+    get<T extends HttpxRequestOption>(details: T): HttpxPromise<HttpxResponse<T>>;
+    /**
+     * GET 请求
+     * @param url 网址
+     * @param details 配置
+     */
+    get<T extends HttpxRequestOption>(url: string, details: T): HttpxPromise<HttpxResponse<T>>;
+    /**
+     * POST 请求
+     * @param details 配置
+     */
+    post<T extends HttpxRequestOption>(details: T): HttpxPromise<HttpxResponse<T>>;
+    /**
+     * POST 请求
+     * @param url 网址
+     */
+    post<T extends HttpxRequestOption>(url: string): HttpxPromise<HttpxResponse<T>>;
+    /**
+     * POST 请求
+     * @param url 网址
+     * @param details 配置
+     */
+    post<T extends HttpxRequestOption>(url: string, details: T): HttpxPromise<HttpxResponse<T>>;
+    /**
+     * HEAD 请求
+     * @param details 配置
+     */
+    head<T extends HttpxRequestOption>(details: T): HttpxPromise<HttpxResponse<T>>;
+    /**
+     * HEAD 请求
+     * @param url 网址
+     */
+    head<T extends HttpxRequestOption>(url: string): HttpxPromise<HttpxResponse<T>>;
+    /**
+     * HEAD 请求
+     * @param url 网址
+     * @param details 配置
+     */
+    head<T extends HttpxRequestOption>(url: string, details: T): HttpxPromise<HttpxResponse<T>>;
+    /**
+     * OPTIONS 请求
+     * @param details 配置
+     */
+    options<T extends HttpxRequestOption>(details: T): HttpxPromise<HttpxResponse<T>>;
+    /**
+     * OPTIONS 请求
+     * @param url 网址
+     */
+    options<T extends HttpxRequestOption>(url: string): HttpxPromise<HttpxResponse<T>>;
+    /**
+     * OPTIONS 请求
+     * @param url 网址
+     * @param details 配置
+     */
+    options<T extends HttpxRequestOption>(url: string, details: T): HttpxPromise<HttpxResponse<T>>;
+    /**
+     * DELETE 请求
+     * @param details 配置
+     */
+    delete<T extends HttpxRequestOption>(details: T): HttpxPromise<HttpxResponse<T>>;
+    /**
+     * DELETE 请求
+     * @param url 网址
+     */
+    delete<T extends HttpxRequestOption>(url: string): HttpxPromise<HttpxResponse<T>>;
+    /**
+     * DELETE 请求
+     * @param url 网址
+     * @param details 配置
+     */
+    delete<T extends HttpxRequestOption>(url: string, details: T): HttpxPromise<HttpxResponse<T>>;
+    /**
+     * PUT 请求
+     * @param details 配置
+     */
+    put<T extends HttpxRequestOption>(details: T): HttpxPromise<HttpxResponse<T>>;
+    /**
+     * PUT 请求
+     * @param url 网址
+     */
+    put<T extends HttpxRequestOption>(url: string): HttpxPromise<HttpxResponse<T>>;
+    /**
+     * PUT 请求
+     * @param url 网址
+     * @param details 配置
+     */
+    put<T extends HttpxRequestOption>(url: string, details: T): HttpxPromise<HttpxResponse<T>>;
+    /**
+     * 发送请求
+     * @param details 配置
+     * @param beforeRequestOption 处理请求前的配置
+     */
+    request<T extends HttpxRequestOption>(details: T, beforeRequestOption?: (option: Required<T>) => void): HttpxPromise<HttpxResponse<T>>;
+}
+export { Httpx };

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

@@ -1799,6 +1799,12 @@ declare class Utils {
      * Utils.toUrl("/s?word=666");
      */
     toUrl(text: string): URL;
+    /**
+     * 覆盖对象中的函数this指向
+     * @param target 需要覆盖的对象
+     * @param [objectThis] 覆盖的this指向，如果为传入，则默认为对象本身
+     */
+    coverObjectFunctionThis(target: any, objectThis?: any): void;
     /**
      * 生成uuid
      * @example

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

@@ -1210,12 +1210,7 @@ export declare interface HttpxRequestOption {
 /**
  * 自定义的配置请求
  */
-export declare interface HttpxRequestOptionConfig extends HttpxRequestOption {
-	/**
-	 * （可选）是否输出请求配置
-	 */
-	logDetails?: boolean;
-}
+export declare interface HttpxRequestOptionConfig extends HttpxInitOption {}
 /**
  * 响应的数据的data
  */
@@ -1334,3 +1329,26 @@ export declare interface HttpxHookErrorData {
 export declare interface HttpxPromise<T> extends Promise<T> {
 	abort: () => void;
 }
+
+/**
+ * httpx的初始化配置
+ */
+export declare interface HttpxInitOption extends HttpxRequestOption {
+	/**
+	 * 实例化，可传入GM_xmlhttpRequest，未传入则使用window.fetch
+	 */
+	xmlHttpRequest?: Function;
+	/**
+	 * `baseURL` 将自动加在 `url` 前面，除非 `url` 是一个绝对 URL。
+	 */
+	baseURL?: string | undefined;
+	/**
+	 * 重试次数
+	 * @default 0
+	 */
+	retry?: number;
+	/**
+	 * （可选）是否输出请求配置
+	 */
+	logDetails?: boolean;
+}

package/package.json

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