minutool 1.0.21 → 1.0.23

package/dist/index.d.ts

@@ -12,9 +12,16 @@ export declare const abortableFetch: (url: string, fetchOption?: RequestOption)
 
 /**
  * 可中止的 Fetch 请求
+ * 完全独立定义，避免与 Promise 类型混淆
  */
-export declare interface AbortablePromise<T> extends Promise<T> {
+export declare interface AbortablePromise<T> extends PromiseLike<T> {
     abort: () => void;
+    abortSilently: () => void;
+    aborted: boolean;
+    then<TResult1 = T, TResult2 = never>(onfulfilled?: ((value: T) => TResult1 | PromiseLike<TResult1>) | undefined | null, onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | undefined | null): AbortablePromise<TResult1 | TResult2>;
+    catch<TResult = never>(onrejected?: ((reason: any) => TResult | PromiseLike<TResult>) | undefined | null): AbortablePromise<T | TResult>;
+    finally(onfinally?: (() => void) | undefined | null): AbortablePromise<T>;
+    readonly [Symbol.toStringTag]: "Promise";
 }
 
 export declare class AbortError extends Error {
@@ -132,43 +139,43 @@ export declare const between: (val: number, min: number, max: number, includeEqu
 /**
  * 绑定点击事件，并返回一个解绑函数
  * @param element - 要绑定事件的元素
- * @param callback - 事件回调函数
+ * @param payload - 事件回调函数
  * @returns 解绑函数
  */
-export declare const bindClick: (element: HTMLElement | string, callback: (event: Event) => void) => () => void;
+export declare const bindClick: (element: EventTarget | string, payload: (event: Event) => void) => () => void;
 
 /**
  * 绑定DOM事件，并返回一个解绑函数
  * @param element - 要绑定事件的元素
  * @param eventName - 事件名称
- * @param callback - 事件回调函数
+ * @param payload - 事件回调函数
  * @returns 解绑函数
  */
-export declare const bindDomEvent: (element: HTMLElement | string, eventName: string, callback: (event: Event) => void) => () => void;
+export declare const bindDomEvent: <E extends Event = Event>(element: EventTarget | string, eventName: string, payload: (event: E) => void) => () => void;
 
 /**
  * 绑定双击事件，并返回一个解绑函数
  * @param element - 要绑定事件的元素
- * @param callback - 事件回调函数
+ * @param payload - 事件回调函数
  * @returns 解绑函数
  */
-export declare const bindDoubleClick: (element: HTMLElement | string, callback: (event: Event) => void) => () => void;
+export declare const bindDoubleClick: (element: EventTarget | string, payload: (event: Event) => void) => () => void;
 
 /**
  * 绑定键盘按键按下事件，并返回一个解绑函数
  * @param element - 要绑定事件的元素
- * @param callback - 事件回调函数
+ * @param payload - 事件回调函数
  * @returns 解绑函数
  */
-export declare const bindKeyDown: (element: HTMLElement | string, callback: (event: Event) => void) => () => void;
+export declare const bindKeyDown: (element: EventTarget | string, payload: (event: Event) => void) => () => void;
 
 /**
  * 绑定键盘按键抬起事件，并返回一个解绑函数
  * @param element - 要绑定事件的元素
- * @param callback - 事件回调函数
+ * @param payload - 事件回调函数
  * @returns 解绑函数
  */
-export declare const bindKeyUp: (element: HTMLElement | string, callback: (event: Event) => void) => () => void;
+export declare const bindKeyUp: (element: EventTarget | string, payload: (event: Event) => void) => () => void;
 
 /**
  * 绑定对象移动事件
@@ -478,7 +485,7 @@ export declare const escapeHtml: (str: string, tabSize?: number, allowLineBreake
  * @param handler 事件处理函数, 参数为事件对象和匹配的子元素 (event, target)
  * @return 返回一个取消事件委托的函数
  */
-export declare const eventDelegate: (parent: HTMLElement | string, selector: string, event: string, handler: (event: Event, target: HTMLElement) => void) => () => void;
+export declare const eventDelegate: (parent: EventTarget | string, selector: string, event: string, handler: (event: Event, target: Element) => void) => () => void;
 
 /**
  * 退出全屏模式
@@ -600,7 +607,7 @@ export declare const getDomDimension: (dom: HTMLElement) => {
  * @example
  * getJson('/api/users').then(data => console.log(data))
  */
-export declare const getJson: (url: string, data?: any, option?: RequestOption) => Promise<any>;
+export declare const getJson: (url: string, data?: any, option?: RequestOption) => AbortablePromise<any>;
 
 /**
  * 获取节点的 XPath
@@ -1391,14 +1398,14 @@ export declare const onDocReady: (handler: () => void) => void;
 
 /**
  * 监听节点树变更
- * @param {HTMLElement} dom - 要监听的 DOM 节点
- * @param {Function} callback - 回调函数
- * @param {boolean} [includeElementChanged=true] - 是否包含表单元素的值变更
+ * @param dom - 要监听的 DOM 节点
+ * @param payload - 回调函数
+ * @param includeElementChanged - 是否包含表单元素的值变更
  * @returns {void}
  * @example
  * onDomTreeChange(container, () => console.log('changed'))
  */
-export declare const onDomTreeChange: (dom: HTMLElement, callback: () => void, includeElementChanged?: boolean) => void;
+export declare const onDomTreeChange: (dom: HTMLElement, payload: () => void, includeElementChanged?: boolean) => void;
 
 export declare const ONE_DAY: number;
 
@@ -1459,7 +1466,7 @@ export declare const parseUnit: (value: string | number, defaultUnit?: string) =
  * @example
  * postFiles('/api/upload', {avatar: fileObject})
  */
-export declare const postFiles: (url: string, fileMap: Record<string, File>, data?: any, option?: RequestOption) => Promise<any>;
+export declare const postFiles: (url: string, fileMap: Record<string, File>, data?: any, option?: RequestOption) => AbortablePromise<any>;
 
 /**
  * 发送 POST 请求并获取 JSON 响应
@@ -1470,7 +1477,7 @@ export declare const postFiles: (url: string, fileMap: Record<string, File>, dat
  * @example
  * postJson('/api/users', {name: 'John'}).then(data => console.log(data))
  */
-export declare const postJson: (url: string, data?: any, option?: RequestOption) => Promise<any>;
+export declare const postJson: (url: string, data?: any, option?: RequestOption) => AbortablePromise<any>;
 
 /**
  * 精度位数转小数表示法
@@ -1828,7 +1835,7 @@ export declare const toggleFullScreen: (element: any) => Promise<unknown>;
  * @param node HTML节点
  * @param event 事件名称
  */
-export declare const triggerDomEvent: (node: HTMLElement, event: string) => void;
+export declare const triggerDomEvent: (node: EventTarget, event: string) => void;
 
 /**
  * 去除字符串首尾指定字符或空白