minutool 1.0.16 → 1.0.18

package/dist/index.d.ts

@@ -213,6 +213,8 @@ 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;
 
 /**
@@ -331,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;
 
 /**
  * 计算数字位数
@@ -474,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 方式格式化）
@@ -712,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 - 要检测的对象
@@ -722,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 - 要检测的对象
@@ -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[]}
@@ -1527,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;
 
@@ -1590,6 +1624,36 @@ export declare const stripSlashes: (str: string) => string;
  */
 export declare const strToPascalCase: (str: string, capitalize_first?: boolean) => string;
 
+/**
+ * 兼容方式获取svg的BBox，避免Firefox获取svg尺寸时，额外考虑了父容器的zoom
+ * @param {SVGSVGElement} svg
+ * @returns {DOMRect}
+ * @returns {DOMRect.width} 单位px
+ * @returns {DOMRect.height} 单位px
+ * @see https://stackoverflow.com/questions/60814803/getboundingbox-of-svg-element-in-firefox
+ */
+export declare const svgGetBBox: (svg: SVGSVGElement) => DOMRect;
+
+/**
+ * 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 - 纯文本字符串