sculp-js 1.8.4 → 1.10.0

package/lib/index.d.ts

@@ -285,10 +285,10 @@ declare function getComputedCssVal(el: HTMLElement, property: string, reNumber?:
  * 字符串的像素宽度
  * @param {string} str 目标字符串
  * @param {number} fontSize 字符串字体大小
- * @param {boolean} isRemoveDom 计算后是否移除中间dom元素
+ * @param {boolean} isRemove 计算后是否移除创建的dom元素
  * @returns {*}
  */
-declare function getStrWidthPx(str: string, fontSize?: number, isRemoveDom?: boolean): number;
+declare function getStrWidthPx(str: string, fontSize?: number, isRemove?: boolean): number;
 
 interface Params<T = string | number> {
     [key: string]: T | Array<T>;
@@ -526,9 +526,10 @@ interface Url {
 /**
  * url 解析
  * @param {string} url
+ * @param {boolean} isModernApi 使用现代API:URL, 默认true (对无效url解析会抛错), 否则使用a标签来解析（兼容性更强）
  * @returns {Url}
  */
-declare const urlParse: (url: string) => Url;
+declare const urlParse: (url: string, isModernApi?: boolean) => Url;
 /**
  * url 字符化，url 对象里的 searchParams 会覆盖 url 原有的查询参数
  * @param {Url} url
@@ -595,23 +596,23 @@ interface ICompressOptions {
 declare function compressImg(file: File | FileList, options: ICompressOptions): Promise<object> | undefined;
 
 interface ICanvasWM {
-    container: HTMLElement;
-    width: string;
-    height: string;
-    textAlign: CanvasTextAlign;
-    textBaseline: CanvasTextBaseline;
-    font: string;
-    fillStyle: string;
-    content: string;
-    rotate: number;
-    zIndex: number;
+    rootContainer?: HTMLElement | string;
+    width?: string;
+    height?: string;
+    textAlign?: CanvasTextAlign;
+    textBaseline?: CanvasTextBaseline;
+    font?: string;
+    fillStyle?: string;
+    rotate?: number;
+    zIndex?: number;
+    watermarkId?: string;
 }
 /**
  * canvas 实现 水印, 具备防删除功能
  * @param {ICanvasWM} canvasWM
  * @example genCanvasWM({ content: 'QQMusicFE' })
  */
-declare function genCanvasWM(canvasWM: ICanvasWM): void;
+declare function genCanvasWM(content?: string, canvasWM?: ICanvasWM): void;
 
 interface DebounceFunc<F extends AnyFunc> {
     (...args: Parameters<F>): void;
@@ -697,22 +698,45 @@ declare const HEX_POOL: string;
  * @returns {string}
  */
 declare function numberToHex(decimal: number | string, hexPool?: string): string;
+interface INumberAbbr {
+    ratio?: number;
+    decimals?: number;
+    separator?: string;
+}
 /**
- * 缩写
+ * 将数字转换为携带单位的字符串
  * @param {number | string} num
  * @param {Array<string>} units
- * @param {number} ratio
- * @param {number} exponent
+ * @param {INumberAbbr} options default: { ratio: 1000, decimals: 0, separator: ' ' }
  * @returns {string}
  */
-declare const numberAbbr: (num: number | string, units: Array<string>, ratio?: number, exponent?: number) => string;
+declare const numberAbbr: (num: number | string, units: Array<string>, options?: INumberAbbr) => string;
+interface IHumanFileSizeOptions {
+    decimals?: number;
+    si?: boolean;
+    separator?: string;
+    baseUnit?: string;
+    maxUnit?: string;
+}
+/**
+ * Converting file size in bytes to human-readable string
+ *  reference: https://zh.wikipedia.org/wiki/%E5%8D%83%E5%AD%97%E8%8A%82
+ * @param {number | string} num bytes Number in Bytes
+ * @param {IHumanFileSizeOptions} options default: { decimals = 0, si = false, separator = ' ' }
+ *        si: True to use metric (SI) units, aka powers of 1000, the units is
+ *            ['B', 'kB', 'MB', 'GB', 'TB', 'PB', 'EB', 'ZB', 'YB'].
+ *            False to use binary (IEC), aka powers of 1024, the units is
+ *            ['Byte', 'KiB', 'MiB', 'GiB', 'TiB', 'PiB', 'EiB', 'ZiB', 'YiB']
+ * @returns
+ */
+declare function humanFileSize(num: number | string, options?: IHumanFileSizeOptions): string;
 /**
  * 将数字格式化成千位分隔符显示的字符串
- * @param {number} val 数字
- * @param {'int' | 'float'} type 展示分段显示的类型 int:整型 | float:浮点型
+ * @param {number|string} num 数字
+ * @param {number} decimals 格式化成指定小数位精度的参数
  * @returns {string}
  */
-declare function formatNumber(val: number, type?: string): string;
+declare function formatNumber(num: number | string, decimals?: number): string;
 
 declare const UNIQUE_NUMBER_SAFE_LENGTH = 18;
 /**
@@ -740,26 +764,28 @@ declare const uniqueString: UniqueString;
  * @Desc 自定义的tooltip方法, 支持拖动悬浮提示
  * Created by chendeqiao on 2017/5/8.
  * @example
- *  <span onmouseleave="handleMouseLeave('#root')" onmousemove="handleMouseEnter({rootElId: '#root', title: 'title content', event: event})"
- * 		onmouseenter="handleMouseEnter({'#root', title: 'title content', event: event})">title content </span>
+ *  <span onmouseleave="handleMouseLeave('#root')" onmousemove="handleMouseEnter({rootContainer: '#root', title: 'title content', event: event})"
+ * 		onmouseenter="handleMouseEnter({rootContainer:'#root', title: 'title content', event: event})">title content </span>
  */
 interface ITooltipParams {
-    rootElId: string;
+    rootContainer: HTMLElement | string;
     title: string;
-    event: PointerEvent;
+    event: PointerEvent | MouseEvent;
+    bgColor?: string;
+    color?: string;
 }
 /**
  * 自定义title提示功能的mouseenter事件句柄
  * @param {ITooltipParams} param1
  * @returns {*}
  */
-declare function handleMouseEnter({ rootElId, title, event }: ITooltipParams): void;
+declare function handleMouseEnter({ rootContainer, title, event, bgColor, color }: ITooltipParams): void;
 /**
  * 移除提示文案dom的事件句柄
- * @param {string} rootElId
+ * @param {string} rootContainer
  * @returns {*}
  */
-declare function handleMouseLeave(rootElId?: string): void;
+declare function handleMouseLeave(rootContainer?: HTMLElement | string): void;
 declare const tooltipEvent: {
     handleMouseEnter: typeof handleMouseEnter;
     handleMouseLeave: typeof handleMouseLeave;
@@ -1066,4 +1092,4 @@ type Comparable = null | undefined | boolean | number | string | Date | RegExp |
  */
 declare function isEqual(a: Comparable, b: Comparable): boolean;
 
-export { type AnyArray, type AnyFunc, type AnyObject, type ArrayElements, type Comparable, type DateObj, type DateValue, type DebounceFunc, EMAIL_REGEX, type FileType, HEX_POOL, HTTP_URL_REGEX, type ICanvasWM, type ICompressOptions, type IFieldOptions, type IFilterCondition, IPV4_REGEX, IPV6_REGEX, type ISearchTreeOpts, type ITreeConf, type IdLike, type LooseParamValue, type LooseParams, type ObjectAssignItem, type OnceFunc, PHONE_REGEX, type Params, type PartialDeep, type RandomString, type Replacer, STRING_ARABIC_NUMERALS, STRING_LOWERCASE_ALPHA, STRING_POOL, STRING_UPPERCASE_ALPHA, type SetStyle, type SmoothScrollOptions, type Style, type ThrottleFunc, UNIQUE_NUMBER_SAFE_LENGTH, URL_REGEX, type UniqueString, type Url, add, addClass, arrayEach, arrayEachAsync, arrayInsertBefore, arrayLike, arrayRemove, asyncMap, calculateDate, calculateDateTime, chooseLocalFile, cloneDeep, compressImg, cookieDel, cookieGet, cookieSet, copyText, crossOriginDownload, dateParse, dateToEnd, dateToStart, debounce, decodeFromBase64, divide, downloadBlob, downloadData, downloadHref, downloadURL, encodeToBase64, escapeRegExp, executeInScope, flatTree, forEachDeep, formatDate, formatNumber, formatTree, fuzzySearchTree, genCanvasWM, getComputedCssVal, getGlobal, getStrWidthPx, getStyle, hasClass, isArray, isBigInt, isBoolean, isDate, isDigit, isEmail, isEmpty, isEqual, isError, isFloat, isFunction, isIdNo, isInteger, isIpV4, isIpV6, isJsonString, isNaN, isNull, isNullOrUnDef, isNullOrUnDef as isNullish, isNumber, isNumerical, isObject, isPhone, isPlainObject, isPrimitive, isRegExp, isString, isSymbol, isUndefined, isUrl, isValidDate, mapDeep, multiply, numberAbbr, numberToHex, objectAssign, objectEach, objectEachAsync, objectFill, objectGet, objectHas, objectMap, objectAssign as objectMerge, objectOmit, objectPick, once, parseQueryParams, parseVarFromString, pathJoin, pathNormalize, qsParse, qsStringify, randomNumber, randomString, randomUuid, removeClass, replaceVarFromString, searchTreeById, setGlobal, setStyle, smoothScroll, stringAssign, stringCamelCase, stringEscapeHtml, stringFill, stringFormat, stringKebabCase, strip, subtract, supportCanvas, throttle, tooltipEvent, typeIs, uniqueNumber, uniqueString, uniqueSymbol, urlDelParams, urlParse, urlSetParams, urlStringify, wait, weAtob, weBtoa };
+export { type AnyArray, type AnyFunc, type AnyObject, type ArrayElements, type Comparable, type DateObj, type DateValue, type DebounceFunc, EMAIL_REGEX, type FileType, HEX_POOL, HTTP_URL_REGEX, type ICanvasWM, type ICompressOptions, type IFieldOptions, type IFilterCondition, IPV4_REGEX, IPV6_REGEX, type ISearchTreeOpts, type ITreeConf, type IdLike, type LooseParamValue, type LooseParams, type ObjectAssignItem, type OnceFunc, PHONE_REGEX, type Params, type PartialDeep, type RandomString, type Replacer, STRING_ARABIC_NUMERALS, STRING_LOWERCASE_ALPHA, STRING_POOL, STRING_UPPERCASE_ALPHA, type SetStyle, type SmoothScrollOptions, type Style, type ThrottleFunc, UNIQUE_NUMBER_SAFE_LENGTH, URL_REGEX, type UniqueString, type Url, add, addClass, arrayEach, arrayEachAsync, arrayInsertBefore, arrayLike, arrayRemove, asyncMap, calculateDate, calculateDateTime, chooseLocalFile, cloneDeep, compressImg, cookieDel, cookieGet, cookieSet, copyText, crossOriginDownload, dateParse, dateToEnd, dateToStart, debounce, decodeFromBase64, divide, downloadBlob, downloadData, downloadHref, downloadURL, encodeToBase64, escapeRegExp, executeInScope, flatTree, forEachDeep, formatDate, formatNumber as formatMoney, formatNumber, formatTree, fuzzySearchTree, genCanvasWM, getComputedCssVal, getGlobal, getStrWidthPx, getStyle, hasClass, humanFileSize, isArray, isBigInt, isBoolean, isDate, isDigit, isEmail, isEmpty, isEqual, isError, isFloat, isFunction, isIdNo, isInteger, isIpV4, isIpV6, isJsonString, isNaN, isNull, isNullOrUnDef, isNullOrUnDef as isNullish, isNumber, isNumerical, isObject, isPhone, isPlainObject, isPrimitive, isRegExp, isString, isSymbol, isUndefined, isUrl, isValidDate, mapDeep, multiply, numberAbbr, numberToHex, objectAssign, objectEach, objectEachAsync, objectFill, objectGet, objectHas, objectMap, objectAssign as objectMerge, objectOmit, objectPick, once, parseQueryParams, parseVarFromString, pathJoin, pathNormalize, qsParse, qsStringify, randomNumber, randomString, randomUuid, removeClass, replaceVarFromString, searchTreeById, setGlobal, setStyle, smoothScroll, stringAssign, stringCamelCase, stringEscapeHtml, stringFill, stringFormat, stringKebabCase, strip, subtract, supportCanvas, throttle, tooltipEvent, typeIs, uniqueNumber, uniqueString, uniqueSymbol, urlDelParams, urlParse, urlSetParams, urlStringify, wait, weAtob, weBtoa };