sculp-js 0.1.1 → 1.0.0

package/README.md

@@ -12,6 +12,7 @@
 js 工具函数库, 包含类型判断模块：type, 数据处理模块：`array`、`object`、`string`、`number`，功能性模块：下载`download`、复制`clipboard`、`cookie`、日期`date`、qs、水印`watermark`, 文件处理模块：`file`，自定义悬浮提示模块： `tooltip`, dom处理模块：`dom`;
 
 - Array
+
   - arrayLike 判断类数组
   - arrayEach 可中断的数组遍历， 支持倒序
   - arrayEachAsync 异步遍历数组，可中断，支持倒序
@@ -19,3 +20,5 @@ js 工具函数库, 包含类型判断模块：type, 数据处理模块：`array
   - arrayRemove 数组删除指定元素
   - deepTraversal 深度优先遍历函数, 支持continue、break，可定制id、children
   - getTreeIds 在树中找到 id 为某个值的节点，并返回上游的所有父级节点
+
+## [API文档详情](https://chandq.github.io/sculp-js/)

package/lib/cjs/array.js

@@ -1,5 +1,5 @@
 /*!
- * sculp-js v0.1.0
+ * sculp-js v1.0.0
  * (c) 2023-2023 chandq
  * Released under the MIT License.
  */
@@ -11,10 +11,11 @@ var type = require('./type.js');
 
 /**
  * 判断一个对象是否为类数组
+ *
  * @param any
  * @returns {boolean}
  */
-const arrayLike = (any) => {
+function arrayLike(any) {
     if (type.isArray(any))
         return true;
     if (type.isString(any))
@@ -22,14 +23,16 @@ const arrayLike = (any) => {
     if (!type.isObject(any))
         return false;
     return object.objectHas(any, 'length');
-};
+}
 /**
  * 遍历数组，返回 false 中断遍历
+ *
  * @param {ArrayLike<V>} array
  * @param {(val: V, idx: number) => any} iterator
  * @param reverse {boolean} 是否倒序
+ * @returns {*}
  */
-const arrayEach = (array, iterator, reverse = false) => {
+function arrayEach(array, iterator, reverse = false) {
     if (reverse) {
         for (let idx = array.length - 1; idx >= 0; idx--) {
             const val = array[idx];
@@ -44,12 +47,12 @@ const arrayEach = (array, iterator, reverse = false) => {
                 break;
         }
     }
-};
+}
 /**
  * 异步遍历数组，返回 false 中断遍历
- * @param {ArrayLike<V>} array
- * @param {(val: V, idx: number) => Promise<any>} iterator
- * @param {boolean} reverse
+ * @param {ArrayLike<V>} array 数组
+ * @param {(val: V, idx: number) => Promise<any>} iterator  支持Promise类型的回调函数
+ * @param {boolean} reverse  是否反向遍历
  */
 async function arrayEachAsync(array, iterator, reverse = false) {
     if (reverse) {
@@ -72,15 +75,16 @@ async function arrayEachAsync(array, iterator, reverse = false) {
  * @param {AnyArray} array
  * @param {number} start
  * @param {number} to
+ * @returns {*}
  */
-const arrayInsertBefore = (array, start, to) => {
+function arrayInsertBefore(array, start, to) {
     if (start === to || start + 1 === to)
         return;
     // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
     const [source] = array.splice(start, 1);
     const insertIndex = to < start ? to : to - 1;
     array.splice(insertIndex, 0, source);
-};
+}
 /**
  * 数组删除指定项目
  * @param {V[]} array
@@ -101,17 +105,18 @@ function arrayRemove(array, expect) {
 }
 /**
  * 自定义深度优先遍历函数(支持continue和break操作)
- * @param {array} deepList
- * @param {function} iterator
- * @param {array} children
- * @param {boolean} isReverse 是否反向遍历
+ * @param {ArrayLike<V>} tree  树形数据
+ * @param {Function} iterator  迭代函数
+ * @param {string} children 定制子元素的key
+ * @param {boolean} isReverse  是否反向遍历
+ * @returns {*}
  */
-const deepTraversal = (deepList, iterator, children = 'children', isReverse = false) => {
+function deepTraversal(tree, iterator, children = 'children', isReverse = false) {
     let level = 0;
     const walk = (arr, parent) => {
         if (isReverse) {
             for (let i = arr.length - 1; i >= 0; i--) {
-                const re = iterator(arr[i], i, deepList, parent, level);
+                const re = iterator(arr[i], i, tree, parent, level);
                 if (re === 'break') {
                     break;
                 }
@@ -128,7 +133,7 @@ const deepTraversal = (deepList, iterator, children = 'children', isReverse = fa
         }
         else {
             for (let i = 0; i < arr.length; i++) {
-                const re = iterator(arr[i], i, deepList, parent, level);
+                const re = iterator(arr[i], i, tree, parent, level);
                 if (re === 'break') {
                     break;
                 }
@@ -144,14 +149,15 @@ const deepTraversal = (deepList, iterator, children = 'children', isReverse = fa
             }
         }
     };
-    walk(deepList, null);
-};
+    walk(tree, null);
+}
 /**
  * 在树中找到 id 为某个值的节点，并返回上游的所有父级节点
- * @param {ArrayLike<T>} tree
- * @param {IdLike} nodeId
- * @param {ITreeConf} config
- * @return {[IdLike[], ITreeItem<V>[]]}
+ *
+ * @param {ArrayLike<T>} tree - 树形数据
+ * @param {IdLike} nodeId - 元素ID
+ * @param {ITreeConf} config - 迭代配置项
+ * @returns {[IdLike[], ITreeItem<V>[]]} - 由parentId...childId, parentObject-childObject组成的二维数组
  */
 function getTreeIds(tree, nodeId, config) {
     const { children = 'children', id = 'id' } = config || {};

package/lib/cjs/async.js

@@ -1,5 +1,5 @@
 /*!
- * sculp-js v0.1.0
+ * sculp-js v1.0.0
  * (c) 2023-2023 chandq
  * Released under the MIT License.
  */
@@ -11,7 +11,7 @@
  * @param {number} timeout 等待时间，单位毫秒
  * @returns {Promise<void>}
  */
-async function wait(timeout = 1) {
+function wait(timeout = 1) {
     return new Promise(resolve => setTimeout(resolve, timeout));
 }
 /**
@@ -23,7 +23,7 @@ async function wait(timeout = 1) {
  * @param {number} concurrency 并发数量，默认无限
  * @returns {Promise<R[]>}
  */
-async function asyncMap(list, mapper, concurrency = Infinity) {
+function asyncMap(list, mapper, concurrency = Infinity) {
     return new Promise((resolve, reject) => {
         const iterator = list[Symbol.iterator]();
         const limit = Math.min(list.length, concurrency);

package/lib/cjs/clipboard.js

@@ -1,5 +1,5 @@
 /*!
- * sculp-js v0.1.0
+ * sculp-js v1.0.0
  * (c) 2023-2023 chandq
  * Released under the MIT License.
  */
@@ -20,7 +20,7 @@ document.body.appendChild(textEl);
  * 复制文本
  * @param {string} text
  */
-const copyText = (text) => {
+function copyText(text) {
     textEl.value = text;
     textEl.focus({ preventScroll: true });
     textEl.select();
@@ -31,6 +31,6 @@ const copyText = (text) => {
     catch (err) {
         // ignore
     }
-};
+}
 
 exports.copyText = copyText;

package/lib/cjs/cookie.js

@@ -1,5 +1,5 @@
 /*!
- * sculp-js v0.1.0
+ * sculp-js v1.0.0
  * (c) 2023-2023 chandq
  * Released under the MIT License.
  */
@@ -13,7 +13,7 @@ var type = require('./type.js');
  * @param {string} name
  * @returns {string}
  */
-const cookieGet = (name) => {
+function cookieGet(name) {
     const { cookie } = document;
     if (!cookie)
         return '';
@@ -25,14 +25,14 @@ const cookieGet = (name) => {
             return decodeURIComponent(val);
     }
     return '';
-};
+}
 /**
  * 设置 cookie
  * @param {string} name
  * @param {string} value
  * @param {number | Date} [maxAge]
  */
-const cookieSet = (name, value, maxAge) => {
+function cookieSet(name, value, maxAge) {
     const metas = [];
     const EXPIRES = 'expires';
     metas.push([name, encodeURIComponent(value)]);
@@ -51,7 +51,7 @@ const cookieSet = (name, value, maxAge) => {
         return `${key}=${val}`;
     })
         .join(';');
-};
+}
 /**
  * 删除单个 cookie
  * @param name cookie 名称

package/lib/cjs/date.js

@@ -1,11 +1,66 @@
 /*!
- * sculp-js v0.1.0
+ * sculp-js v1.0.0
  * (c) 2023-2023 chandq
  * Released under the MIT License.
  */
 
 'use strict';
 
+var type = require('./type.js');
+
+const isValidDate = (any) => type.isDate(any) && !type.isNaN(any.getTime());
+/* istanbul ignore next */
+const guessDateSeparator = (value) => {
+    if (!type.isString(value))
+        return;
+    const value2 = value.replace(/-/g, '/');
+    return new Date(value2);
+};
+/* istanbul ignore next */
+const guessDateTimezone = (value) => {
+    if (!type.isString(value))
+        return;
+    const re = /([+-])(\d\d)(\d\d)$/;
+    const matches = re.exec(value);
+    if (!matches)
+        return;
+    const value2 = value.replace(re, 'Z');
+    const d = new Date(value2);
+    if (!isValidDate(d))
+        return;
+    const [, flag, hours, minutes] = matches;
+    const hours2 = parseInt(hours, 10);
+    const minutes2 = parseInt(minutes, 10);
+    const offset = (a, b) => (flag === '+' ? a - b : a + b);
+    d.setHours(offset(d.getHours(), hours2));
+    d.setMinutes(offset(d.getMinutes(), minutes2));
+    return d;
+};
+/**
+ * 解析为Date对象
+ * @param {DateValue} value - 可以是数值、字符串或 Date 对象
+ * @returns {Date} - 转换后的目标Date
+ */
+function dateParse(value) {
+    const d1 = new Date(value);
+    if (isValidDate(d1))
+        return d1;
+    // safari 浏览器的日期解析有问题
+    // new Date('2020-06-26 18:06:15') 返回值是一个非法日期对象
+    /* istanbul ignore next */
+    const d2 = guessDateSeparator(value);
+    /* istanbul ignore next */
+    if (isValidDate(d2))
+        return d2;
+    // safari 浏览器的日期解析有问题
+    // new Date('2020-06-26T18:06:15.000+0800') 返回值是一个非法日期对象
+    /* istanbul ignore next */
+    const d3 = guessDateTimezone(value);
+    /* istanbul ignore next */
+    if (isValidDate(d3))
+        return d3;
+    throw new SyntaxError(`${value.toString()} 不是一个合法的日期描述`);
+}
 /**
  * 格式化为日期对象(带自定义格式化模板)
  * @param {DateValue} value 可以是数值、字符串或 Date 对象
@@ -20,10 +75,69 @@
  * - mm：分
  * - ss：秒
  * - SSS：毫秒
- * - ww: 周
  * @returns {string}
  */
-const formatDate = (date = new Date(), format = 'YYYY-MM-DD HH:mm:ss') => {
+// export const dateStringify = (value: DateValue, format = 'YYYY-MM-DD HH:mm:ss'): string => {
+//   const date = dateParse(value);
+//   let fmt = format;
+//   let ret;
+//   const opt: DateObj = {
+//     'Y+': `${date.getFullYear()}`, // 年
+//     'y+': `${date.getFullYear()}`, // 年
+//     'M+': `${date.getMonth() + 1}`, // 月
+//     'D+': `${date.getDate()}`, // 日
+//     'd+': `${date.getDate()}`, // 日
+//     'H+': `${date.getHours()}`, // 时
+//     'm+': `${date.getMinutes()}`, // 分
+//     's+': `${date.getSeconds()}`, // 秒
+//     'S+': `${date.getMilliseconds()}` // 豪秒
+//   };
+//   for (const k in opt) {
+//     ret = new RegExp(`(${k})`).exec(fmt);
+//     if (ret) {
+//       fmt = fmt.replace(ret[1], ret[1].length === 1 ? opt[k] : opt[k].padStart(ret[1].length, '0'));
+//     }
+//   }
+//   return fmt;
+// };
+/**
+ * 将日期转换为一天的开始时间，即0点0分0秒0毫秒
+ * @param {DateValue} value
+ * @returns {Date}
+ */
+function dateToStart(value) {
+    const d = dateParse(value);
+    return new Date(d.getFullYear(), d.getMonth(), d.getDate(), 0, 0, 0, 0);
+}
+/**
+ * 将日期转换为一天的结束时间，即23点59分59秒999毫秒
+ * @param {DateValue} value
+ * @returns {Date}
+ */
+function dateToEnd(value) {
+    const d = dateToStart(value);
+    d.setDate(d.getDate() + 1);
+    return dateParse(d.getTime() - 1);
+}
+/**
+ * 格式化为日期对象(带自定义格式化模板)
+ * @param {Date} value - 可以是数值、字符串或 Date 对象
+ * @param {string} [format] - 模板，默认是 YYYY-MM-DD HH:mm:ss，模板字符：
+ * - YYYY：年
+ * - yyyy: 年
+ * - MM：月
+ * - DD：日
+ * - dd: 日
+ * - HH：时（24 小时制）
+ * - hh：时（12 小时制）
+ * - mm：分
+ * - ss：秒
+ * - SSS：毫秒
+ * - ww: 周
+ * @returns {string}  格式化后的日期字符串
+ */
+function formatDate(value, format = 'YYYY-MM-DD HH:mm:ss') {
+    const date = dateParse(value);
     let fmt = format;
     let ret;
     const opt = {
@@ -46,13 +160,13 @@ const formatDate = (date = new Date(), format = 'YYYY-MM-DD HH:mm:ss') => {
         }
     }
     return fmt;
-};
+}
 /**
  * 计算向前或向后N天的具体日期
- * @param {string} strDate 参考日期
- * @param {number} n 正数：向后推算；负数：向前推算
- * @param {string} sep 日期格式的分隔符
- * @return {*} 目标日期
+ * @param {string} strDate - 参考日期
+ * @param {number} n - 正数：向后推算；负数：向前推算
+ * @param {string} sep - 日期格式的分隔符
+ * @returns {string} 计算后的目标日期
  */
 function calculateDate(strDate, n, sep = '-') {
     //strDate 为字符串日期 如:'2019-01-01' n为你要传入的参数，当前为0，前一天为-1，后一天为1
@@ -70,10 +184,10 @@ function calculateDate(strDate, n, sep = '-') {
 }
 /**
  * 计算向前或向后N天的具体时间日期
- * @param {number} n 正数：向后推算；负数：向前推算
- * @param {string} dateSep 日期分隔符
- * @param {string} timeSep 时间分隔符
- * @return {*}
+ * @param {number} n - 正数：向后推算；负数：向前推算
+ * @param {string} dateSep - 日期分隔符
+ * @param {string} timeSep - 时间分隔符
+ * @returns {string} 转换后的目标日期时间
  */
 function calculateDateTime(n, dateSep = '-', timeSep = ':') {
     const date = new Date();
@@ -111,4 +225,8 @@ function calculateDateTime(n, dateSep = '-', timeSep = ':') {
 
 exports.calculateDate = calculateDate;
 exports.calculateDateTime = calculateDateTime;
+exports.dateParse = dateParse;
+exports.dateToEnd = dateToEnd;
+exports.dateToStart = dateToStart;
 exports.formatDate = formatDate;
+exports.isValidDate = isValidDate;

package/lib/cjs/dom.js

@@ -1,5 +1,5 @@
 /*!
- * sculp-js v0.1.0
+ * sculp-js v1.0.0
  * (c) 2023-2023 chandq
  * Released under the MIT License.
  */
@@ -18,11 +18,11 @@ var type = require('./type.js');
  * @param {string} className
  * @returns {boolean}
  */
-const hasClass = (el, className) => {
+function hasClass(el, className) {
     if (className.indexOf(' ') !== -1)
         throw new Error('className should not contain space.');
     return el.classList.contains(className);
-};
+}
 const eachClassName = (classNames, func) => {
     const classNameList = classNames.split(/\s+/g);
     classNameList.forEach(func);
@@ -32,17 +32,17 @@ const eachClassName = (classNames, func) => {
  * @param {HTMLElement} el
  * @param {string} classNames
  */
-const addClass = (el, classNames) => {
+function addClass(el, classNames) {
     eachClassName(classNames, className => el.classList.add(className));
-};
+}
 /**
  * 给元素移除样式名
  * @param {HTMLElement} el
  * @param {string} classNames
  */
-const removeClass = (el, classNames) => {
+function removeClass(el, classNames) {
     eachClassName(classNames, className => el.classList.remove(className));
-};
+}
 /**
  * 设置元素样式
  * @param {HTMLElement} el
@@ -61,12 +61,14 @@ const setStyle = (el, key, val) => {
 };
 /**
  * 获取元素样式
- * @param {HTMLElement} el
+ * @param {HTMLElement} el 元素
  * @param {string} key
  * @returns {string}
  */
-const getStyle = (el, key) => getComputedStyle(el).getPropertyValue(key);
-async function smoothScroll(options) {
+function getStyle(el, key) {
+    return getComputedStyle(el).getPropertyValue(key);
+}
+function smoothScroll(options) {
     return new Promise(resolve => {
         const defaults = {
             el: document,
@@ -146,7 +148,7 @@ function onDomReady(callback) {
  * @param {HTMLElement} el
  * @param {string} property
  * @param {boolean} reNumber
- * @return {string|number}
+ * @returns {string|number}
  */
 function getComputedCssVal(el, property, reNumber = true) {
     const originVal = getComputedStyle(el).getPropertyValue(property) ?? '';

package/lib/cjs/download.js

@@ -1,5 +1,5 @@
 /*!
- * sculp-js v0.1.0
+ * sculp-js v1.0.0
  * (c) 2023-2023 chandq
  * Released under the MIT License.
  */
@@ -13,15 +13,15 @@ var url = require('./url.js');
  * @param {string} url
  * @param {LooseParams} params
  */
-const downloadURL = (url$1, params) => {
+function downloadURL(url$1, params) {
     window.open(params ? url.urlSetParams(url$1, params) : url$1);
-};
+}
 /**
  * 通过 A 链接的方式下载
  * @param {string} href
  * @param {string} filename
  */
-const downloadHref = (href, filename) => {
+function downloadHref(href, filename) {
     const eleLink = document.createElement('a');
     eleLink.download = filename;
     eleLink.style.display = 'none';
@@ -29,17 +29,17 @@ const downloadHref = (href, filename) => {
     document.body.appendChild(eleLink);
     eleLink.click();
     setTimeout(() => document.body.removeChild(eleLink));
-};
+}
 /**
  * 将大文件对象通过 A 链接的方式下载
  * @param {Blob} blob
  * @param {string} filename
  */
-const downloadBlob = (blob, filename) => {
+function downloadBlob(blob, filename) {
     const objURL = URL.createObjectURL(blob);
     downloadHref(objURL, filename);
     setTimeout(() => URL.revokeObjectURL(objURL));
-};
+}
 /**
  * 将指定数据格式通过 A 链接的方式下载
  * @param {AnyObject | AnyObject[]} data
@@ -47,7 +47,7 @@ const downloadBlob = (blob, filename) => {
  * @param {string} filename
  * @param {string[]} [headers]
  */
-const downloadData = (data, fileType, filename, headers) => {
+function downloadData(data, fileType, filename, headers) {
     filename = filename.replace(`.${fileType}`, '') + `.${fileType}`;
     if (fileType === 'json') {
         const blob = new Blob([JSON.stringify(data, null, 4)]);
@@ -74,7 +74,7 @@ const downloadData = (data, fileType, filename, headers) => {
         const href = 'data:' + MIMETypes[fileType] + ';charset=utf-8,\ufeff' + encodeURIComponent(headerStr + bodyStr);
         downloadHref(href, filename);
     }
-};
+}
 
 exports.downloadBlob = downloadBlob;
 exports.downloadData = downloadData;

package/lib/cjs/easing.js

@@ -1,5 +1,5 @@
 /*!
- * sculp-js v0.1.0
+ * sculp-js v1.0.0
  * (c) 2023-2023 chandq
  * Released under the MIT License.
  */

package/lib/cjs/file.js

@@ -1,5 +1,5 @@
 /*!
- * sculp-js v0.1.0
+ * sculp-js v1.0.0
  * (c) 2023-2023 chandq
  * Released under the MIT License.
  */
@@ -8,10 +8,11 @@
 
 /**
  * 选择本地文件
- * @param {function} changeCb 选择文件回调
- * @return {*}
+ * @param {string} accept 上传的文件类型，用于过滤
+ * @param {Function} changeCb 选择文件回调
+ * @returns {HTMLInputElement}
  */
-function chooseLocalFile({ accept }, changeCb) {
+function chooseLocalFile(accept, changeCb) {
     const inputObj = document.createElement('input');
     inputObj.setAttribute('id', String(Date.now()));
     inputObj.setAttribute('type', 'file');

package/lib/cjs/func.js

@@ -1,5 +1,5 @@
 /*!
- * sculp-js v0.1.0
+ * sculp-js v1.0.0
  * (c) 2023-2023 chandq
  * Released under the MIT License.
  */

package/lib/cjs/index.js

@@ -1,5 +1,5 @@
 /*!
- * sculp-js v0.1.0
+ * sculp-js v1.0.0
  * (c) 2023-2023 chandq
  * Released under the MIT License.
  */
@@ -41,7 +41,11 @@ exports.cookieGet = cookie.cookieGet;
 exports.cookieSet = cookie.cookieSet;
 exports.calculateDate = date.calculateDate;
 exports.calculateDateTime = date.calculateDateTime;
+exports.dateParse = date.dateParse;
+exports.dateToEnd = date.dateToEnd;
+exports.dateToStart = date.dateToStart;
 exports.formatDate = date.formatDate;
+exports.isValidDate = date.isValidDate;
 exports.addClass = dom.addClass;
 exports.getComputedCssVal = dom.getComputedCssVal;
 exports.getStyle = dom.getStyle;

package/lib/cjs/number.js

@@ -1,5 +1,5 @@
 /*!
- * sculp-js v0.1.0
+ * sculp-js v1.0.0
  * (c) 2023-2023 chandq
  * Released under the MIT License.
  */
@@ -21,7 +21,7 @@ const remainder = (x, y) => (supportBigInt ? x % y : jsbi().remainder(x, y));
  * @param {string} [hexPool] 进制池，默认 62 进制
  * @returns {string}
  */
-const numberToHex = (decimal, hexPool = HEX_POOL) => {
+function numberToHex(decimal, hexPool = HEX_POOL) {
     if (hexPool.length < 2)
         throw new Error('进制池长度不能少于 2');
     if (!supportBigInt) {
@@ -43,7 +43,7 @@ const numberToHex = (decimal, hexPool = HEX_POOL) => {
     };
     execute();
     return ret.join('');
-};
+}
 /**
  * 缩写
  * @param {number | string} num
@@ -70,7 +70,7 @@ const numberAbbr = (num, units, ratio = 1000, exponent) => {
  * 将数字格式化成千位分隔符显示的字符串
  * @param {number} val 数字
  * @param {'int' | 'float'} type 展示分段显示的类型 int:整型 | float:浮点型
- * @return {string}
+ * @returns {string}
  */
 function formatNumber(val, type = 'int') {
     return type === 'int' ? parseInt(String(val)).toLocaleString() : Number(val).toLocaleString('en-US');