minutool 1.0.15 → 1.0.17

package/dist/index.d.ts

@@ -174,6 +174,16 @@ export declare const buildHtmlHidden: (maps: Record<string, any>) => string;
  */
 export declare const buildStyleVars: (vars: Record<string, number | string | undefined>) => Record<string, string>;
 
+/**
+ * 计算剩余时间，单位为毫秒
+ * @param progress 当前进度
+ * @param total 总进度
+ * @param startTime 开始时间（毫秒时间戳）
+ * @returns 剩余时间，单位毫秒
+ * @description 根据当前进度、总进度和已用时间估算剩余时间。公式为：剩余时间 = (已用时间 / 当前进度) * (总进度 - 当前进度)。如果当前进度为0，则返回Infinity。
+ */
+export declare const calcRemainingMSecs: (progress: number, total: number, startTime: number) => number;
+
 /**
  * 驼峰命名转换
  * @param str - 输入字符串
@@ -203,13 +213,12 @@ export declare function capitalize(str: string): string;
  */
 export declare const cleanNull: (obj: any, recursive?: boolean) => any;
 
+export declare const COMMON_DPI = 96;
+
 export declare const convertMinutesToTimezoneOffsetStr: (offsetMinutes: number) => string;
 
 /**
  * 倒计时函数（该方法采用 setTimeout 方式，不够精准）
- * @param {number} timeout - 倒计时总秒数
- * @param {Function} [tickFunc] - 每秒回调函数，接收剩余秒数作为参数
- * @param {Function} [onFinish] - 倒计时结束回调函数
  * @returns {void}
  * @example
  * countDown(10, (sec) => console.log(sec), () => console.log('done'))
@@ -324,7 +333,7 @@ export declare const detectedPrecision: (...numbers: number[]) => number;
  * @example
  * detectLanguage(['en', 'zh-CN', 'zh']) // '根据浏览器语言返回匹配的语言'
  */
-export declare const detectLanguage: (supportedLngs: string[]) => any;
+export declare const detectLanguage: (supportedLngs: string[]) => string;
 
 /**
  * 计算数字位数
@@ -443,23 +452,17 @@ export declare const fileToBase64DataUri: (file: File | Blob | string) => Promis
 
 /**
  * 通过选择器查找子节点（强制添加 :scope 来约束必须是子节点）
- * @param {string|HTMLElement|HTMLElement[]|NodeList|HTMLCollection} selector - 选择器或 DOM 元素
- * @param {Document|HTMLElement} [parent=document] - 父节点，默认为 document
- * @returns {HTMLElement[]} 返回查找到的所有元素数组
  * @example
  * findAll('.item', container)
  */
-export declare const findAll: (selector: string | HTMLElement | HTMLElement[] | NodeList | HTMLCollection, parent?: Document | HTMLElement) => HTMLElement[];
+export declare const findAll: (selector: string | Element | Element[], parent?: Document | DocumentFragment | Element) => Element[];
 
 /**
  * 通过选择器查找单个节点
- * @param {string|HTMLElement} selector - 选择器，如果是 HTMLElement，则直接返回
- * @param {Document|HTMLElement} [parent=document] - 父节点，默认为 document
- * @returns {HTMLElement} 返回查找到的元素
  * @example
  * findOne('.item')
  */
-export declare const findOne: (selector: string | HTMLElement, parent?: Document | HTMLElement) => HTMLElement;
+export declare const findOne: (selector: string | Element, parent?: Document | DocumentFragment | Element) => Element | null;
 
 /**
  * 修复基本 URL（将相对路径转换为绝对 URL）
@@ -473,10 +476,11 @@ export declare const fixBaseUrl: (url: string, baseUrl: string) => string;
 
 /**
  * 将字符串转换为浮点数
- * @param {string} str - 要转换的字符串
+ * @param {*} str - 要转换的字符串
  * @param {number} [defaultVal=0] - 转换失败时的默认值
+ * @returns {number} 返回转换后的浮点数，如果转换失败则返回默认值
  */
-export declare const floatVal: (str: string, defaultVal?: number) => number;
+export declare const floatVal: (str: any, defaultVal?: number) => number;
 
 /**
  * 格式化日期（以 PHP 方式格式化）
@@ -587,6 +591,7 @@ export declare const guid: (prefix?: string) => string;
 
 /**
  * 隐藏节点（通过设置 display:none 方式）
+ * 注：只有 HTMLElement 才有 style 属性，其他类型的 Node 没有，因此需要断言为 HTMLElement
  * @param {HTMLElement|string} dom - DOM 元素或选择器
  * @returns {void}
  * @example
@@ -710,6 +715,15 @@ export declare const isJSON: (json: string) => boolean;
  */
 export declare const isJson: (json: string) => boolean;
 
+export declare const isLandscape: () => boolean;
+
+/**
+ * 判断一个值是否为数字
+ * @param val - 要判断的值
+ * @returns 如果是数字返回 true，否则返回 false
+ */
+export declare const isNumberic: (val: any) => boolean;
+
 /**
  * 检测目标是否为 Object（非数组的对象）
  * @param {any} item - 要检测的对象
@@ -720,6 +734,8 @@ export declare const isJson: (json: string) => boolean;
  */
 export declare const isObject: (item: any) => boolean;
 
+export declare const isPortrait: () => boolean;
+
 /**
  * 检测对象是否为 Promise 对象
  * @param {any} obj - 要检测的对象
@@ -1178,8 +1194,6 @@ export declare const MONTH_NOW: number;
 
 /**
  * 毫秒转换为“时分秒前”格式
- * @param {number} ms - 毫秒数
- * @returns {string} 返回格式化后的字符串
  * @example
  * msToHMS(3661000) // '1小时0分钟1秒前'
  */
@@ -1226,7 +1240,14 @@ export declare function objectGet<T = any>(obj: any, path: string, defaultValue?
  * @example
  * objectKeyMapping({a: 1, b: 2}, {a: 'x'}) // {x: 1, b: 2}
  */
-export declare const objectKeyMapping: (obj: Record<string, any>, mapping: Record<string, string>) => Record<string, any>;
+export declare const objectKeyReplace: (obj: Record<string, any>, mapping: Record<string, string>) => Record<string, any>;
+
+/**
+ * 交换对象中的键值对
+ * @param {Object} obj
+ * @returns
+ */
+export declare const objectKeyValSwap: (obj: object) => any;
 
 /**
  * 合并对象
@@ -1295,8 +1316,11 @@ export declare const ONE_YEAR366: number;
  * 订阅事件，event 可以是字符串或 Symbol，handler 是事件处理函数
  * @param {string | symbol} event 事件名称
  * @param {Function} handler 事件处理函数
+ * @return {Function} 返回一个取消订阅的函数
  */
-export declare const onEvent: (event: string | symbol, handler: EventListenerOrEventListenerObject) => void;
+export declare const onEvent: (event: string | symbol, handler: EventListenerOrEventListenerObject) => () => void;
+
+export declare const onEvents: (events: (string | symbol)[], handler: EventListenerOrEventListenerObject) => () => void;
 
 export declare const onHover: (el: HTMLElement | string, onHoverIn: () => void, onHoverOut: () => void) => void;
 
@@ -1307,6 +1331,14 @@ export declare const onHover: (el: HTMLElement | string, onHoverIn: () => void,
  */
 export declare const PAIR_TAGS: string[];
 
+/**
+ * 解析带单位的值，返回数值和单位
+ */
+export declare const parseUnit: (value: string | number, defaultUnit?: string) => {
+    val: number;
+    unit: string;
+} | null;
+
 /**
  * 上传文件
  * @param {string} url - 请求 URL
@@ -1495,6 +1527,8 @@ export declare const round: (num: number, precision?: number) => number;
  */
 export declare const sanitizeFileName: (name: string) => string;
 
+export declare const SCREEN_DPI: number;
+
 /**
  * 自关闭标签
  * @type {string[]}
@@ -1517,6 +1551,7 @@ export declare const setCookie: (name: string, value: string, days: number, path
 
 /**
  * 显示节点（通过设置 display 为空方式）
+ * 注：只有 HTMLElement 才有 style 属性，其他类型的 Node 没有，因此需要断言为 HTMLElement
  * @param {HTMLElement|string} dom - DOM 元素或选择器
  * @returns {void}
  * @example
@@ -1526,13 +1561,13 @@ export declare const show: (dom: HTMLElement | string) => void;
 
 /**
  * 通过图片 URL 获取 Base64（网络请求模式）
- * @param {string} src - 图片 URL
+ * @param {string} url - 图片 URL
  * @param {boolean} [cache=false] - 是否缓存结果
  * @returns {Promise<unknown>} 返回 Base64 Data URL 的 Promise
  * @example
  * srcToBase64('https://example.com/image.png').then(base64 => console.log(base64))
  */
-export declare const srcToBase64: (src: string, cache?: boolean) => Promise<unknown>;
+export declare const srcToBase64: (url: string, cache?: boolean) => Promise<unknown>;
 
 export declare const STAND_DPI = 96;
 
@@ -1589,6 +1624,26 @@ export declare const stripSlashes: (str: string) => string;
  */
 export declare const strToPascalCase: (str: string, capitalize_first?: boolean) => string;
 
+/**
+ * svg 对象转换为图片对象
+ * @returns
+ */
+export declare const svgToImg: (svg: SVGSVGElement) => Promise<HTMLImageElement>;
+
+/**
+ * svg 对象转换为图片数据
+ * @param {SVGSVGElement} svg
+ * @param {String} format
+ * @param {number} quality
+ * @returns
+ */
+export declare const svgToImgData: (svg: SVGSVGElement, format?: string | null, quality?: number | null) => Promise<string>;
+
+/**
+ * svg 对象转换为图片数据
+ */
+export declare const svgToSrc: (svg: SVGSVGElement) => string;
+
 /**
  * 将纯文本转换为 HTML（转义特殊字符并处理换行）
  * @param {string} text - 纯文本字符串
@@ -1621,6 +1676,15 @@ export declare const throttle: (fn: Function, intervalMiSec: number) => Function
  */
 export declare const throttleEffect: (fn: Function, intervalMiSec: number) => Function;
 
+/**
+ * 将时间戳转换为本地时间的日期时间字符串（YYYY-MM-DDTHH:mm），
+ * 一般用于填充到 input[type="datetime-local"] 的 value 属性中
+ * @param timestamp 时间戳，可以是数字、字符串或 Date 对象
+ * @param includeSec 是否包含秒，默认为 false，如果为 true 则返回的字符串格式为 YYYY-MM-DDTHH:mm:ss
+ * @returns 本地时间的日期时间字符串，格式为 YYYY-MM-DDTHH:mm:ss（如果 includeSec 参数为 true 则包含秒）
+ */
+export declare const timestampToDateTimeLocal: (timestamp: number | string | Date, includeSec?: boolean) => string;
+
 /**
  * 禁用启用元素切换
  * @param {String|Node} el