sculp-js 0.0.1 → 0.1.1

package/lib/index.d.ts

@@ -22,30 +22,6 @@ declare const isDate: (any: unknown) => any is Date;
 declare const isError: (any: unknown) => any is Error;
 declare const isRegExp: (any: unknown) => any is RegExp;
 
-type type_AnyArray = AnyArray;
-type type_AnyFunc<R = any> = AnyFunc<R>;
-type type_AnyObject = AnyObject;
-type type_ArrayElements<A> = ArrayElements<A>;
-type type_PartialDeep<T> = PartialDeep<T>;
-declare const type_isArray: typeof isArray;
-declare const type_isBigInt: typeof isBigInt;
-declare const type_isBoolean: typeof isBoolean;
-declare const type_isDate: typeof isDate;
-declare const type_isError: typeof isError;
-declare const type_isFunction: typeof isFunction;
-declare const type_isNaN: typeof isNaN;
-declare const type_isNull: typeof isNull;
-declare const type_isNumber: typeof isNumber;
-declare const type_isObject: typeof isObject;
-declare const type_isPrimitive: typeof isPrimitive;
-declare const type_isRegExp: typeof isRegExp;
-declare const type_isString: typeof isString;
-declare const type_isSymbol: typeof isSymbol;
-declare const type_isUndefined: typeof isUndefined;
-declare namespace type {
-  export { type type_AnyArray as AnyArray, type type_AnyFunc as AnyFunc, type type_AnyObject as AnyObject, type type_ArrayElements as ArrayElements, type type_PartialDeep as PartialDeep, typeIs as default, type_isArray as isArray, type_isBigInt as isBigInt, type_isBoolean as isBoolean, type_isDate as isDate, type_isError as isError, type_isFunction as isFunction, type_isNaN as isNaN, type_isNull as isNull, type_isNumber as isNumber, type_isObject as isObject, type_isPrimitive as isPrimitive, type_isRegExp as isRegExp, type_isString as isString, type_isSymbol as isSymbol, type_isUndefined as isUndefined };
-}
-
 /**
  * 判断一个对象是否为类数组
  * @param any
@@ -58,7 +34,7 @@ declare const arrayLike: (any: unknown) => boolean;
  * @param {(val: V, idx: number) => any} iterator
  * @param reverse {boolean} 是否倒序
  */
-declare const arrayEach: <V>(array: ArrayLike<V>, iterator: (val: V, idx: number) => any, reverse?: boolean) => void;
+declare const arrayEach: <V>(array: ArrayLike<V>, iterator: (val: V, idx: number, arr: ArrayLike<V>) => any, reverse?: boolean) => void;
 /**
  * 异步遍历数组，返回 false 中断遍历
  * @param {ArrayLike<V>} array
@@ -101,42 +77,6 @@ interface ITreeConf {
  * @return {[IdLike[], ITreeItem<V>[]]}
  */
 declare function getTreeIds<V>(tree: ArrayLike<V>, nodeId: IdLike, config?: ITreeConf): [IdLike[], ArrayLike<V>[]];
-/**
- * 异步ForEach函数
- * @param {array} array
- * @param {asyncFuntion} callback
- * // asyncForEach 使用范例如下
-// const start = async () => {
-//   await asyncForEach(result, async (item) => {
-//     await request(item);
-//     count++;
-//   });
-
-//   console.log('发送次数', count);
-// }
-
-// for await...of 使用范例如下
-// const loadImages =  async (images) => {
-//   for await (const item of images) {
-//      await request(item);
-//      count++;
-//    }
-// }
- * @return {*}
- */
-declare function asyncForEach(array: any[], callback: Function): Promise<void>;
-
-declare const array_arrayEach: typeof arrayEach;
-declare const array_arrayEachAsync: typeof arrayEachAsync;
-declare const array_arrayInsertBefore: typeof arrayInsertBefore;
-declare const array_arrayLike: typeof arrayLike;
-declare const array_arrayRemove: typeof arrayRemove;
-declare const array_asyncForEach: typeof asyncForEach;
-declare const array_deepTraversal: typeof deepTraversal;
-declare const array_getTreeIds: typeof getTreeIds;
-declare namespace array {
-  export { array_arrayEach as arrayEach, array_arrayEachAsync as arrayEachAsync, array_arrayInsertBefore as arrayInsertBefore, array_arrayLike as arrayLike, array_arrayRemove as arrayRemove, array_asyncForEach as asyncForEach, array_deepTraversal as deepTraversal, array_getTreeIds as getTreeIds };
-}
 
 /**
  * 复制文本
@@ -144,11 +84,6 @@ declare namespace array {
  */
 declare const copyText: (text: string) => void;
 
-declare const clipboard_copyText: typeof copyText;
-declare namespace clipboard {
-  export { clipboard_copyText as copyText };
-}
-
 /**
  * 获取cookie
  * @param {string} name
@@ -168,13 +103,6 @@ declare const cookieSet: (name: string, value: string, maxAge?: number | Date) =
  */
 declare const cookieDel: (name: string) => void;
 
-declare const cookie_cookieDel: typeof cookieDel;
-declare const cookie_cookieGet: typeof cookieGet;
-declare const cookie_cookieSet: typeof cookieSet;
-declare namespace cookie {
-  export { cookie_cookieDel as cookieDel, cookie_cookieGet as cookieGet, cookie_cookieSet as cookieSet };
-}
-
 /**
  * 格式化为日期对象(带自定义格式化模板)
  * @param {DateValue} value 可以是数值、字符串或 Date 对象
@@ -210,13 +138,6 @@ declare function calculateDate(strDate: string, n: number, sep?: string): string
  */
 declare function calculateDateTime(n: number, dateSep?: string, timeSep?: string): string;
 
-declare const date_calculateDate: typeof calculateDate;
-declare const date_calculateDateTime: typeof calculateDateTime;
-declare const date_formatDate: typeof formatDate;
-declare namespace date {
-  export { date_calculateDate as calculateDate, date_calculateDateTime as calculateDateTime, date_formatDate as formatDate };
-}
-
 type EasingName = 'ease' | 'linear' | 'ease-in' | 'ease-out' | 'ease-in-out' | string;
 
 interface Style {
@@ -270,18 +191,14 @@ declare function smoothScroll(options?: Partial<SmoothScrollOptions>): Promise<v
 type ReadyCallback = () => void;
 declare function isDomReady(): boolean;
 declare function onDomReady(callback: ReadyCallback): void;
-
-declare const dom_addClass: typeof addClass;
-declare const dom_getStyle: typeof getStyle;
-declare const dom_hasClass: typeof hasClass;
-declare const dom_isDomReady: typeof isDomReady;
-declare const dom_onDomReady: typeof onDomReady;
-declare const dom_removeClass: typeof removeClass;
-declare const dom_setStyle: typeof setStyle;
-declare const dom_smoothScroll: typeof smoothScroll;
-declare namespace dom {
-  export { dom_addClass as addClass, dom_getStyle as getStyle, dom_hasClass as hasClass, dom_isDomReady as isDomReady, dom_onDomReady as onDomReady, dom_removeClass as removeClass, dom_setStyle as setStyle, dom_smoothScroll as smoothScroll };
-}
+/**
+ * 获取元素样式属性的计算值
+ * @param {HTMLElement} el
+ * @param {string} property
+ * @param {boolean} reNumber
+ * @return {string|number}
+ */
+declare function getComputedCssVal(el: HTMLElement, property: string, reNumber?: boolean): string | number;
 
 interface Params<T = string | number> {
     [key: string]: T | Array<T>;
@@ -305,16 +222,6 @@ type Replacer = (value: LooseParamValue) => string | null;
  */
 declare const qsStringify: (query: LooseParams, replacer?: Replacer) => string;
 
-type qs_LooseParamValue = LooseParamValue;
-type qs_LooseParams<T = LooseParamValue> = LooseParams<T>;
-type qs_Params<T = string | number> = Params<T>;
-type qs_Replacer = Replacer;
-declare const qs_qsParse: typeof qsParse;
-declare const qs_qsStringify: typeof qsStringify;
-declare namespace qs {
-  export { type qs_LooseParamValue as LooseParamValue, type qs_LooseParams as LooseParams, type qs_Params as Params, type qs_Replacer as Replacer, qs_qsParse as qsParse, qs_qsStringify as qsStringify };
-}
-
 /**
  * 通过打开新窗口的方式下载
  * @param {string} url
@@ -343,14 +250,6 @@ type FileType = 'json' | 'csv' | 'xls' | 'xlsx';
  */
 declare const downloadData: (data: AnyObject | AnyObject[], fileType: FileType, filename: string, headers?: string[]) => void;
 
-declare const download_downloadBlob: typeof downloadBlob;
-declare const download_downloadData: typeof downloadData;
-declare const download_downloadHref: typeof downloadHref;
-declare const download_downloadURL: typeof downloadURL;
-declare namespace download {
-  export { download_downloadBlob as downloadBlob, download_downloadData as downloadData, download_downloadHref as downloadHref, download_downloadURL as downloadURL };
-}
-
 /**
  * 判断对象是否为纯对象
  * @param {object} obj
@@ -427,21 +326,6 @@ declare function objectGet(obj: AnyObject, path: string, strict?: boolean): {
  */
 declare function cloneDeep(obj: Object, map?: WeakMap<WeakKey, any>): Object;
 
-declare const object_cloneDeep: typeof cloneDeep;
-declare const object_isPlainObject: typeof isPlainObject;
-declare const object_objectAssign: typeof objectAssign;
-declare const object_objectEach: typeof objectEach;
-declare const object_objectEachAsync: typeof objectEachAsync;
-declare const object_objectFill: typeof objectFill;
-declare const object_objectGet: typeof objectGet;
-declare const object_objectHas: typeof objectHas;
-declare const object_objectMap: typeof objectMap;
-declare const object_objectOmit: typeof objectOmit;
-declare const object_objectPick: typeof objectPick;
-declare namespace object {
-  export { object_cloneDeep as cloneDeep, object_isPlainObject as isPlainObject, object_objectAssign as objectAssign, object_objectEach as objectEach, object_objectEachAsync as objectEachAsync, object_objectFill as objectFill, object_objectGet as objectGet, object_objectHas as objectHas, object_objectMap as objectMap, objectAssign as objectMerge, object_objectOmit as objectOmit, object_objectPick as objectPick };
-}
-
 /**
  * 标准化路径
  * @param {string} path
@@ -456,12 +340,6 @@ declare const pathNormalize: (path: string) => string;
  */
 declare const pathJoin: (from: string, ...to: string[]) => string;
 
-declare const path_pathJoin: typeof pathJoin;
-declare const path_pathNormalize: typeof pathNormalize;
-declare namespace path {
-  export { path_pathJoin as pathJoin, path_pathNormalize as pathNormalize };
-}
-
 /**
  * 将字符串转换为驼峰格式
  * @param {string} string
@@ -521,19 +399,14 @@ declare const stringEscapeHtml: (html: string) => string;
  * @returns {string}
  */
 declare const stringFill: (length: number, value?: string) => string;
-
-declare const string_STRING_ARABIC_NUMERALS: typeof STRING_ARABIC_NUMERALS;
-declare const string_STRING_LOWERCASE_ALPHA: typeof STRING_LOWERCASE_ALPHA;
-declare const string_STRING_UPPERCASE_ALPHA: typeof STRING_UPPERCASE_ALPHA;
-declare const string_stringAssign: typeof stringAssign;
-declare const string_stringCamelCase: typeof stringCamelCase;
-declare const string_stringEscapeHtml: typeof stringEscapeHtml;
-declare const string_stringFill: typeof stringFill;
-declare const string_stringFormat: typeof stringFormat;
-declare const string_stringKebabCase: typeof stringKebabCase;
-declare namespace string {
-  export { string_STRING_ARABIC_NUMERALS as STRING_ARABIC_NUMERALS, string_STRING_LOWERCASE_ALPHA as STRING_LOWERCASE_ALPHA, string_STRING_UPPERCASE_ALPHA as STRING_UPPERCASE_ALPHA, string_stringAssign as stringAssign, string_stringCamelCase as stringCamelCase, string_stringEscapeHtml as stringEscapeHtml, string_stringFill as stringFill, string_stringFormat as stringFormat, string_stringKebabCase as stringKebabCase };
-}
+/**
+ * 字符串的像素宽度
+ * @param {string} str 目标字符串
+ * @param {number} fontSize 字符串字体大小
+ * @param {boolean} isRemoveDom 计算后是否移除中间dom元素
+ * @return {*}
+ */
+declare function getStrWidthPx(str: string, fontSize?: number, isRemoveDom?: boolean): number;
 
 interface Url {
     protocol: string;
@@ -578,14 +451,6 @@ declare const urlSetParams: (url: string, setter: AnyObject) => string;
  */
 declare const urlDelParams: (url: string, removeKeys: string[]) => string;
 
-declare const url_urlDelParams: typeof urlDelParams;
-declare const url_urlParse: typeof urlParse;
-declare const url_urlSetParams: typeof urlSetParams;
-declare const url_urlStringify: typeof urlStringify;
-declare namespace url {
-  export { url_urlDelParams as urlDelParams, url_urlParse as urlParse, url_urlSetParams as urlSetParams, url_urlStringify as urlStringify };
-}
-
 /**
  * 等待一段时间
  * @param {number} timeout 等待时间，单位毫秒
@@ -603,12 +468,6 @@ declare function wait(timeout?: number): Promise<void>;
  */
 declare function asyncMap<T, R>(list: Array<T>, mapper: (val: T, idx: number, list: Array<T>) => Promise<R>, concurrency?: number): Promise<R[]>;
 
-declare const async_asyncMap: typeof asyncMap;
-declare const async_wait: typeof wait;
-declare namespace async {
-  export { async_asyncMap as asyncMap, async_wait as wait };
-}
-
 /**
  * 选择本地文件
  * @param {function} changeCb 选择文件回调
@@ -618,11 +477,6 @@ declare function chooseLocalFile({ accept }: {
     accept: any;
 }, changeCb: (FileList: any) => any): HTMLInputElement;
 
-declare const file_chooseLocalFile: typeof chooseLocalFile;
-declare namespace file {
-  export { file_chooseLocalFile as chooseLocalFile };
-}
-
 interface ICanvasWM {
     container: HTMLElement;
     width: string;
@@ -641,4 +495,126 @@ interface ICanvasWM {
  */
 declare const genCanvasWM: (canvasWM: ICanvasWM) => void;
 
-export { array, async, clipboard, cookie, date, dom, download, file, genCanvasWM, object, path, qs, string, type, url };
+interface DebounceFunc<F extends AnyFunc> {
+    (...args: Parameters<F>): void;
+    cancel: () => void;
+}
+/**
+ * 防抖函数
+ * 当函数被连续调用时，该函数并不执行，只有当其全部停止调用超过一定时间后才执行1次。
+ * 例如：上电梯的时候，大家陆陆续续进来，电梯的门不会关上，只有当一段时间都没有人上来，电梯才会关门。
+ * @param {F} func
+ * @param {number} wait
+ * @returns {DebounceFunc<F>}
+ */
+declare const debounce: <F extends AnyFunc>(func: F, wait?: number) => DebounceFunc<F>;
+interface ThrottleFunc<F extends AnyFunc> {
+    (...args: Parameters<F>): void;
+    cancel: () => void;
+}
+/**
+ * 节流函数
+ * 节流就是节约流量，将连续触发的事件稀释成预设评率。 比如每间隔1秒执行一次函数，无论这期间触发多少次事件。
+ * 这有点像公交车，无论在站点等车的人多不多，公交车只会按时来一班，不会来一个人就来一辆公交车。
+ * @param {F} func
+ * @param {number} wait
+ * @param {boolean} immediate
+ * @returns {ThrottleFunc<F>}
+ */
+declare const throttle: <F extends AnyFunc>(func: F, wait: number, immediate?: boolean) => ThrottleFunc<F>;
+interface OnceFunc<F extends AnyFunc> {
+    (...args: Parameters<F>): ReturnType<F>;
+}
+/**
+ * 单次函数
+ * @param {AnyFunc} func
+ * @returns {AnyFunc}
+ */
+declare const once: <F extends AnyFunc = AnyFunc>(func: F) => OnceFunc<F>;
+/**
+ * 设置全局变量
+ * @param {string | number | symbol} key
+ * @param val
+ */
+declare function setGlobal(key: string | number | symbol, val?: any): void;
+/**
+ * 设置全局变量
+ * @param {string | number | symbol} key
+ * @param val
+ */
+declare function getGlobal<T>(key: string | number | symbol): T | void;
+
+/**
+ * 随机整数
+ * @param {number} min
+ * @param {number} max
+ * @returns {number}
+ */
+declare const randomNumber: (min: number, max: number) => number;
+declare const STRING_POOL = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz";
+interface RandomString {
+    (length: number, pool: string): string;
+    (length: number): string;
+    (pool: string): string;
+    (): string;
+}
+/**
+ * 随机字符串
+ * @param {number | string} length
+ * @param {string} pool
+ * @returns {string}
+ */
+declare const randomString: RandomString;
+/**
+ * 优先浏览器原生能力获取 UUID v4
+ * @returns {string}
+ */
+declare function randomUuid(): string;
+
+declare const HEX_POOL = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz";
+/**
+ * 将十进制转换成任意进制
+ * @param {number | string} decimal 十进制数值或字符串，可以是任意长度，会使用大数进行计算
+ * @param {string} [hexPool] 进制池，默认 62 进制
+ * @returns {string}
+ */
+declare const numberToHex: (decimal: number | string, hexPool?: string) => string;
+/**
+ * 缩写
+ * @param {number | string} num
+ * @param {Array<string>} units
+ * @param {number} ratio
+ * @param {number} exponent
+ * @returns {string}
+ */
+declare const numberAbbr: (num: number | string, units: Array<string>, ratio?: number, exponent?: number) => string;
+/**
+ * 将数字格式化成千位分隔符显示的字符串
+ * @param {number} val 数字
+ * @param {'int' | 'float'} type 展示分段显示的类型 int:整型 | float:浮点型
+ * @return {string}
+ */
+declare function formatNumber(val: number, type?: string): string;
+
+declare const UNIQUE_NUMBER_SAFE_LENGTH = 18;
+/**
+ * 生成唯一不重复数值
+ * @param {number} length
+ * @returns {string}
+ */
+declare const uniqueNumber: (length?: number) => string;
+interface UniqueString {
+    (length: number, pool: string): string;
+    (length: number): string;
+    (pool: string): string;
+    (): string;
+}
+/**
+ * 生成唯一不重复字符串
+ * @param {number | string} length
+ * @param {string} pool
+ * @returns {string}
+ */
+declare const uniqueString: UniqueString;
+
+export { type AnyArray, type AnyFunc, type AnyObject, type ArrayElements, HEX_POOL, type LooseParamValue, type LooseParams, type Params, type PartialDeep, type Replacer, STRING_ARABIC_NUMERALS, STRING_LOWERCASE_ALPHA, STRING_POOL, STRING_UPPERCASE_ALPHA, UNIQUE_NUMBER_SAFE_LENGTH, addClass, arrayEach, arrayEachAsync, arrayInsertBefore, arrayLike, arrayRemove, asyncMap, calculateDate, calculateDateTime, chooseLocalFile, cloneDeep, cookieDel, cookieGet, cookieSet, copyText, debounce, deepTraversal, downloadBlob, downloadData, downloadHref, downloadURL, formatDate, formatNumber, genCanvasWM, getComputedCssVal, getGlobal, getStrWidthPx, getStyle, getTreeIds, hasClass, isArray, isBigInt, isBoolean, isDate, isDomReady, isError, isFunction, isNaN, isNull, isNumber, isObject, isPlainObject, isPrimitive, isRegExp, isString, isSymbol, isUndefined, numberAbbr, numberToHex, objectAssign, objectEach, objectEachAsync, objectFill, objectGet, objectHas, objectMap, objectAssign as objectMerge, objectOmit, objectPick, onDomReady, once, pathJoin, pathNormalize, qsParse, qsStringify, randomNumber, randomString, randomUuid, removeClass, setGlobal, setStyle, smoothScroll, stringAssign, stringCamelCase, stringEscapeHtml, stringFill, stringFormat, stringKebabCase, throttle, typeIs, uniqueNumber, uniqueString, urlDelParams, urlParse, urlSetParams, urlStringify, wait };