sculp-js 0.1.1 → 1.0.0

package/lib/es/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.
  */
@@ -16,11 +16,11 @@ import { isObject } from './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);
@@ -30,17 +30,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
@@ -59,12 +59,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,
@@ -144,7 +146,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/es/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.
  */
@@ -11,15 +11,15 @@ import { urlSetParams } from './url.js';
  * @param {string} url
  * @param {LooseParams} params
  */
-const downloadURL = (url, params) => {
+function downloadURL(url, params) {
     window.open(params ? urlSetParams(url, params) : url);
-};
+}
 /**
  * 通过 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';
@@ -27,17 +27,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
@@ -45,7 +45,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)]);
@@ -72,6 +72,6 @@ const downloadData = (data, fileType, filename, headers) => {
         const href = 'data:' + MIMETypes[fileType] + ';charset=utf-8,\ufeff' + encodeURIComponent(headerStr + bodyStr);
         downloadHref(href, filename);
     }
-};
+}
 
 export { downloadBlob, downloadData, downloadHref, downloadURL };

package/lib/es/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/es/file.js

@@ -1,15 +1,16 @@
 /*!
- * sculp-js v0.1.0
+ * sculp-js v1.0.0
  * (c) 2023-2023 chandq
  * Released under the MIT License.
  */
 
 /**
  * 选择本地文件
- * @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/es/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/es/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.
  */
@@ -7,7 +7,7 @@
 export { arrayEach, arrayEachAsync, arrayInsertBefore, arrayLike, arrayRemove, deepTraversal, getTreeIds } from './array.js';
 export { copyText } from './clipboard.js';
 export { cookieDel, cookieGet, cookieSet } from './cookie.js';
-export { calculateDate, calculateDateTime, formatDate } from './date.js';
+export { calculateDate, calculateDateTime, dateParse, dateToEnd, dateToStart, formatDate, isValidDate } from './date.js';
 export { addClass, getComputedCssVal, getStyle, hasClass, isDomReady, onDomReady, removeClass, setStyle, smoothScroll } from './dom.js';
 export { downloadBlob, downloadData, downloadHref, downloadURL } from './download.js';
 export { cloneDeep, isPlainObject, objectAssign, objectEach, objectEachAsync, objectFill, objectGet, objectHas, objectMap, objectAssign as objectMerge, objectOmit, objectPick } from './object.js';

package/lib/es/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.
  */
@@ -19,7 +19,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) {
@@ -41,7 +41,7 @@ const numberToHex = (decimal, hexPool = HEX_POOL) => {
     };
     execute();
     return ret.join('');
-};
+}
 /**
  * 缩写
  * @param {number | string} num
@@ -68,7 +68,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');

package/lib/es/object.js

@@ -1,5 +1,5 @@
 /*!
- * sculp-js v0.1.0
+ * sculp-js v1.0.0
  * (c) 2023-2023 chandq
  * Released under the MIT License.
  */
@@ -27,20 +27,22 @@ const isPlainObject = (obj) => {
  * @param {string} key
  * @returns {boolean}
  */
-const objectHas = (obj, key) => Object.prototype.hasOwnProperty.call(obj, key);
+function objectHas(obj, key) {
+    return Object.prototype.hasOwnProperty.call(obj, key);
+}
 /**
  * 遍历对象，返回 false 中断遍历
  * @param {O} obj
  * @param {(val: O[keyof O], key: keyof O) => (boolean | void)} iterator
  */
-const objectEach = (obj, iterator) => {
+function objectEach(obj, iterator) {
     for (const key in obj) {
         if (!objectHas(obj, key))
             continue;
         if (iterator(obj[key], key) === false)
             break;
     }
-};
+}
 /**
  * 异步遍历对象，返回 false 中断遍历
  * @param {O} obj
@@ -146,7 +148,7 @@ const merge = (map, source, target) => {
  * @param {ObjectAssignItem | undefined} targets
  * @returns {R}
  */
-const objectAssign = (source, ...targets) => {
+function objectAssign(source, ...targets) {
     const map = new Map();
     for (let i = 0; i < targets.length; i++) {
         const target = targets[i];
@@ -156,7 +158,7 @@ const objectAssign = (source, ...targets) => {
     }
     map.clear();
     return source;
-};
+}
 /**
  * 对象填充
  * @param {Partial<R>} source
@@ -164,7 +166,7 @@ const objectAssign = (source, ...targets) => {
  * @param {(s: Partial<R>, t: Partial<R>, key: keyof R) => boolean} fillable
  * @returns {R}
  */
-const objectFill = (source, target, fillable) => {
+function objectFill(source, target, fillable) {
     const _fillable = fillable || ((source, target, key) => source[key] === undefined);
     objectEach(target, (val, key) => {
         if (_fillable(source, target, key)) {
@@ -172,7 +174,7 @@ const objectFill = (source, target, fillable) => {
         }
     });
     return source;
-};
+}
 function objectGet(obj, path, strict = false) {
     path = path.replace(/\[(\w+)\]/g, '.$1');
     path = path.replace(/^\./, '');
@@ -205,7 +207,7 @@ function objectGet(obj, path, strict = false) {
  * 深拷贝堪称完全体 即：任何类型的数据都会被深拷贝
  * @param {AnyObject | AnyArray} obj
  * @param {WeakMap} map
- * @return {AnyObject | AnyArray}
+ * @returns {AnyObject | AnyArray}
  */
 function cloneDeep(obj, map = new WeakMap()) {
     if (obj instanceof Date)

package/lib/es/path.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/es/qs.js

@@ -1,5 +1,5 @@
 /*!
- * sculp-js v0.1.0
+ * sculp-js v1.0.0
  * (c) 2023-2023 chandq
  * Released under the MIT License.
  */
@@ -12,7 +12,7 @@ import { isUndefined, isArray, isString, isNumber, isBoolean, isDate } from './t
  * @param {string} queryString
  * @returns {Params}
  */
-const qsParse = (queryString) => {
+function qsParse(queryString) {
     const params = new URLSearchParams(queryString);
     const result = {};
     for (const [key, val] of params.entries()) {
@@ -26,7 +26,7 @@ const qsParse = (queryString) => {
         result[key] = params.getAll(key);
     }
     return result;
-};
+}
 const defaultReplacer = (val) => {
     if (isString(val))
         return val;
@@ -44,7 +44,7 @@ const defaultReplacer = (val) => {
  * @param {Replacer} replacer
  * @returns {string}
  */
-const qsStringify = (query, replacer = defaultReplacer) => {
+function qsStringify(query, replacer = defaultReplacer) {
     const params = new URLSearchParams();
     objectEach(query, (val, key) => {
         if (isArray(val)) {
@@ -63,6 +63,6 @@ const qsStringify = (query, replacer = defaultReplacer) => {
         }
     });
     return params.toString();
-};
+}
 
 export { qsParse, qsStringify };

package/lib/es/random.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/es/string.js

@@ -1,5 +1,5 @@
 /*!
- * sculp-js v0.1.0
+ * sculp-js v1.0.0
  * (c) 2023-2023 chandq
  * Released under the MIT License.
  */
@@ -12,24 +12,24 @@ import { isString } from './type.js';
  * @param {boolean} [bigger] 是否大写第一个字母
  * @returns {string}
  */
-const stringCamelCase = (string, bigger) => {
+function stringCamelCase(string, bigger) {
     let string2 = string;
     if (bigger) {
         string2 = string.replace(/^./, origin => origin.toUpperCase());
     }
     const HUMP_RE = /[\s_-](.)/g;
     return string2.replace(HUMP_RE, (orign, char) => char.toUpperCase());
-};
+}
 /**
  * 将字符串转换为连字格式
  * @param {string} string
  * @param {string} [separator] 分隔符，默认是"-"（短横线）
  * @returns {string}
  */
-const stringKebabCase = (string, separator = '-') => {
+function stringKebabCase(string, separator = '-') {
     const string2 = string.replace(/^./, origin => origin.toLowerCase());
     return string2.replace(/[A-Z]/g, origin => `${separator}${origin.toLowerCase()}`);
-};
+}
 const STRING_ARABIC_NUMERALS = '0123456789';
 const STRING_LOWERCASE_ALPHA = 'abcdefghijklmnopqrstuvwxyz';
 const STRING_UPPERCASE_ALPHA = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ';
@@ -45,7 +45,7 @@ const placeholderRE = /%[%sdo]/g;
  * @param args
  * @returns {string}
  */
-const stringFormat = (string, ...args) => {
+function stringFormat(string, ...args) {
     let index = 0;
     const result = string.replace(placeholderRE, (origin) => {
         const arg = args[index++];
@@ -63,7 +63,7 @@ const stringFormat = (string, ...args) => {
         }
     });
     return [result, ...args.splice(index).map(String)].join(' ');
-};
+}
 const ev = (expression, data) => {
     try {
         // eslint-disable-next-line @typescript-eslint/no-implied-eval,@typescript-eslint/no-unsafe-return
@@ -127,7 +127,7 @@ const stringFill = (length, value = ' ') => new Array(length).fill(value).join('
  * @param {string} str 目标字符串
  * @param {number} fontSize 字符串字体大小
  * @param {boolean} isRemoveDom 计算后是否移除中间dom元素
- * @return {*}
+ * @returns {*}
  */
 function getStrWidthPx(str, fontSize = 14, isRemoveDom = false) {
     let strWidth = 0;

package/lib/es/type.js

@@ -1,9 +1,14 @@
 /*!
- * sculp-js v0.1.0
+ * sculp-js v1.0.0
  * (c) 2023-2023 chandq
  * Released under the MIT License.
  */
 
+/**
+ * 判断任意值的数据类型
+ * @param {unknown} any
+ * @returns {string}
+ */
 const typeIs = (any) => Object.prototype.toString.call(any).slice(8, -1);
 // 基本数据类型判断
 const isString = (any) => typeof any === 'string';
@@ -17,7 +22,11 @@ const isPrimitive = (any) => any === null || typeof any !== 'object';
 // 复合数据类型判断
 const isObject = (any) => typeIs(any) === 'Object';
 const isArray = (any) => Array.isArray(any);
-// eslint-disable-next-line @typescript-eslint/ban-types
+/**
+ * 判断是否为函数
+ * @param {unknown} any
+ * @returns {boolean}
+ */
 const isFunction = (any) => typeof any === 'function';
 // 对象类型判断
 const isNaN = (any) => Number.isNaN(any);

package/lib/es/unique.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/es/url.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/es/watermark.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,17 +11,18 @@
  * @desc 网页加水印的工具类
  */
 /**
- * canvas 实现 watermark
+ * canvas 实现 水印, 具备防删除功能
  * @param {ICanvasWM} canvasWM
+ * @example genCanvasWM({ content: 'QQMusicFE' })
  */
-const genCanvasWM = (canvasWM) => {
+function genCanvasWM(canvasWM) {
     const { container = document.body, width = '300px', height = '200px', textAlign = 'center', textBaseline = 'middle', font = '20px PingFangSC-Medium,PingFang SC', 
     // fontWeight = 500,
     fillStyle = 'rgba(189, 177, 167, .3)', content = '请勿外传', rotate = 30, zIndex = 2147483647 } = canvasWM;
     // 仅限主页面添加水印
-    if (!location.pathname.includes('/home')) {
-        return;
-    }
+    // if (!location.pathname.includes('/home')) {
+    //   return;
+    // }
     const args = canvasWM;
     const canvas = document.createElement('canvas');
     canvas.setAttribute('width', width);
@@ -82,8 +83,6 @@ const genCanvasWM = (canvasWM) => {
         });
         mo.observe(container, { attributes: true, subtree: true, childList: true });
     }
-};
-// 调用
-// __canvasWM({ content: 'QQMusicFE' })
+}
 
 export { genCanvasWM };