ph-utils 0.2.22 → 0.3.0

package/lib/dom.js

@@ -1,190 +1,190 @@
-/**
- * web(浏览器端) DOM 文件操作
- * 现今不推荐在使用这种方式，现在开发前端的时候，推荐使用一些成熟的框架例如：React、Preact、Vue、Angular、Svelte、Ember、Knockout等
- * 在使用这些框架的时候额外的一些不可避免的 dom 操作时才使用这个工具；如果确实需要使用原生开发推荐使用 jquery 或者想要更精简的话可以使用 https://github.com/finom/bala 封装
- */
-const vendorPrefix = ['', '-webkit', '-moz-'];
-/**
- * 根据选择器获取节点
- * @param {string} selector 选择器
- */
-export function elem(selector, dom) {
-    if (typeof selector === 'string') {
-        return (dom || document).querySelectorAll(selector);
-    }
-    else {
-        return [selector];
-    }
-}
-/**
- * 为节点添加 class
- * @param {HTMLElement} elem 待添加 class 的节点
- * @param {string} clazz     需要添加的 class
- */
-export function addClass(elem, clazz) {
-    elem.classList.add(clazz);
-}
-/**
- * 节点移除 class
- * @param {HTMLElement} elem 待移除 class 的节点
- * @param {string} clazz     需要移除的 class
- */
-export function removeClass(elem, clazz) {
-    elem.classList.remove(clazz);
-}
-/**
- * 判断节点是否包含某个 class
- * @param elem  待判断 class 的节点
- * @param clazz 待判断的 class
- * @returns
- */
-export function hasClass(elem, clazz) {
-    return elem.classList.contains(clazz);
-}
-/**
- * 为节点添加 transition 属性，包括浏览器前缀
- * @param {HTMLElement} element 需要添加 css Transition 属性的节点
- * @param {string}      value   css transition 值
- */
-export function transition(element, value) {
-    vendorPrefix.forEach((prefix) => {
-        let t = prefix === '' ? 'transition' : prefix + 'Transition';
-        element.style[t] = value;
-    });
-}
-/**
- * 为节点添加 transform 属性，包括浏览器前缀
- * @param {HTMLElement} element  需要添加 css transform 属性的节点
- * @param {string}      value     css transform 值
- */
-export function transform(element, value) {
-    vendorPrefix.forEach((prefix) => {
-        let t = prefix === '' ? 'transform' : prefix + 'Transform';
-        element.style[t] = value;
-    });
-}
-/**
- * 为节点添加事件处理
- * @param {HTMLElement} element   添加事件的节点
- * @param {string}      listener  事件名称
- * @param {function}    event     事件处理函数
- * @param {boolean}     onceOrConfig  是否是只运行一次的处理函数或者配置，其中 eventFlag 为 string，如果配置该项，则表明为委托事件
- */
-export function on(element, listener, fn, once = false) {
-    let eventExtra = { eventStop: false };
-    if (typeof once === 'boolean') {
-        eventExtra.once = once;
-    }
-    else {
-        eventExtra = once;
-    }
-    if (eventExtra.eventFlag != null) {
-        element.setAttribute(eventExtra.eventFlag, '__stop__');
-        element.addEventListener(listener, (e) => {
-            let target = e.target;
-            let flag = '';
-            do {
-                flag = target.getAttribute(eventExtra.eventFlag) || '';
-                if (flag === '') {
-                    target = target.parentNode;
-                }
-            } while (flag === '');
-            if (flag !== '__stop__' || eventExtra.eventStop) {
-                fn(e, target, flag);
-            }
-        }, eventExtra);
-    }
-    else {
-        element.addEventListener(listener, fn, eventExtra);
-    }
-}
-/**
- * 设置或获取节点的 innerHTML 属性
- * @param element
- * @param htmlstr 可选，如果传递该参数，则表示设置；否则表示获取
- * @returns
- */
-export function html(element, htmlstr) {
-    if (htmlstr == null) {
-        return element.innerHTML;
-    }
-    else {
-        element.innerHTML = htmlstr;
-        return undefined;
-    }
-}
-/**
- * 设置或获取节点的 textContent 属性
- * @param element
- * @param textstr 可选，如果传递该参数，则表示设置；否则表示获取
- * @returns
- */
-export function text(element, textstr) {
-    if (textstr == null) {
-        return element.textContent;
-    }
-    else {
-        element.textContent = textstr;
-        return undefined;
-    }
-}
-/**
- * 节点列表遍历
- * @param elems
- * @param fn 遍历到节点时的回调，回调第一个参数为遍历到的节点，第2个参数为 index；如果回调函数返回 true，则会终止遍历(break)
- */
-export function iterate(elems, fn) {
-    for (let i = 0, len = elems.length; i < len; i++) {
-        let r = fn(elems[i], i);
-        if (r === true) {
-            break;
-        }
-    }
-}
-/**
- * 设置或获取节点 data-* 属性
- * @param elem
- * @param key data- 后面跟随的值
- * @param value 如果传递该值表示获取；否则表示设置
- * @returns
- */
-export function attr(elem, key, value) {
-    if (value != null) {
-        elem.setAttribute('data-' + key, value);
-    }
-    else {
-        return elem.getAttribute('data-' + key);
-    }
-}
-/**
- * 获取指定节点的父节点
- * @param el
- * @returns
- */
-export function parent(el) {
-    return el.parentNode;
-}
-/**
- * 获取隐藏节点的尺寸
- * @param {string | HTMLElement} hideNode - The node to hide.
- * @param parent - 添加临时节点的父节点，默认为: body.
- * @returns The DOMRect of the element.
- */
-export function queryHideNodeSize(hideNode, parent = document.body) {
-    // 计算折叠菜单的高度
-    let $tmp = document.createElement('div');
-    $tmp.style.cssText = 'position:fixed;left:-1000px;top:-1000px;opacity:0;';
-    let $tmpInner = document.createElement('div');
-    $tmpInner.style.cssText = 'position:relative;';
-    if (typeof hideNode === 'string') {
-        $tmpInner.innerHTML = hideNode;
-    }
-    else {
-        $tmpInner.appendChild(hideNode.cloneNode(true));
-    }
-    $tmp.appendChild($tmpInner);
-    parent.appendChild($tmp);
-    let rect = $tmpInner.children[0].getBoundingClientRect();
-    parent.removeChild($tmp);
-    return { width: rect.width, height: rect.height };
-}
+/**
+ * web(浏览器端) DOM 文件操作
+ * 现今不推荐在使用这种方式，现在开发前端的时候，推荐使用一些成熟的框架例如：React、Preact、Vue、Angular、Svelte、Ember、Knockout等
+ * 在使用这些框架的时候额外的一些不可避免的 dom 操作时才使用这个工具；如果确实需要使用原生开发推荐使用 jquery 或者想要更精简的话可以使用 https://github.com/finom/bala 封装
+ */
+const vendorPrefix = ['', '-webkit', '-moz-'];
+/**
+ * 根据选择器获取节点
+ * @param {string} selector 选择器
+ */
+export function elem(selector, dom) {
+    if (typeof selector === 'string') {
+        return (dom || document).querySelectorAll(selector);
+    }
+    else {
+        return [selector];
+    }
+}
+/**
+ * 为节点添加 class
+ * @param {HTMLElement} elem 待添加 class 的节点
+ * @param {string} clazz     需要添加的 class
+ */
+export function addClass(elem, clazz) {
+    elem.classList.add(clazz);
+}
+/**
+ * 节点移除 class
+ * @param {HTMLElement} elem 待移除 class 的节点
+ * @param {string} clazz     需要移除的 class
+ */
+export function removeClass(elem, clazz) {
+    elem.classList.remove(clazz);
+}
+/**
+ * 判断节点是否包含某个 class
+ * @param elem  待判断 class 的节点
+ * @param clazz 待判断的 class
+ * @returns
+ */
+export function hasClass(elem, clazz) {
+    return elem.classList.contains(clazz);
+}
+/**
+ * 为节点添加 transition 属性，包括浏览器前缀
+ * @param {HTMLElement} element 需要添加 css Transition 属性的节点
+ * @param {string}      value   css transition 值
+ */
+export function transition(element, value) {
+    vendorPrefix.forEach((prefix) => {
+        let t = prefix === '' ? 'transition' : prefix + 'Transition';
+        element.style[t] = value;
+    });
+}
+/**
+ * 为节点添加 transform 属性，包括浏览器前缀
+ * @param {HTMLElement} element  需要添加 css transform 属性的节点
+ * @param {string}      value     css transform 值
+ */
+export function transform(element, value) {
+    vendorPrefix.forEach((prefix) => {
+        let t = prefix === '' ? 'transform' : prefix + 'Transform';
+        element.style[t] = value;
+    });
+}
+/**
+ * 为节点添加事件处理
+ * @param {HTMLElement} element   添加事件的节点
+ * @param {string}      listener  事件名称
+ * @param {function}    event     事件处理函数
+ * @param {boolean}     onceOrConfig  是否是只运行一次的处理函数或者配置，其中 eventFlag 为 string，如果配置该项，则表明为委托事件
+ */
+export function on(element, listener, fn, once = false) {
+    let eventExtra = { eventStop: false };
+    if (typeof once === 'boolean') {
+        eventExtra.once = once;
+    }
+    else {
+        eventExtra = once;
+    }
+    if (eventExtra.eventFlag != null) {
+        element.setAttribute(eventExtra.eventFlag, '__stop__');
+        element.addEventListener(listener, (e) => {
+            let target = e.target;
+            let flag = '';
+            do {
+                flag = target.getAttribute(eventExtra.eventFlag) || '';
+                if (flag === '') {
+                    target = target.parentNode;
+                }
+            } while (flag === '');
+            if (flag !== '__stop__' || eventExtra.eventStop) {
+                fn(e, target, flag);
+            }
+        }, eventExtra);
+    }
+    else {
+        element.addEventListener(listener, fn, eventExtra);
+    }
+}
+/**
+ * 设置或获取节点的 innerHTML 属性
+ * @param element
+ * @param htmlstr 可选，如果传递该参数，则表示设置；否则表示获取
+ * @returns
+ */
+export function html(element, htmlstr) {
+    if (htmlstr == null) {
+        return element.innerHTML;
+    }
+    else {
+        element.innerHTML = htmlstr;
+        return undefined;
+    }
+}
+/**
+ * 设置或获取节点的 textContent 属性
+ * @param element
+ * @param textstr 可选，如果传递该参数，则表示设置；否则表示获取
+ * @returns
+ */
+export function text(element, textstr) {
+    if (textstr == null) {
+        return element.textContent;
+    }
+    else {
+        element.textContent = textstr;
+        return undefined;
+    }
+}
+/**
+ * 节点列表遍历
+ * @param elems
+ * @param fn 遍历到节点时的回调，回调第一个参数为遍历到的节点，第2个参数为 index；如果回调函数返回 true，则会终止遍历(break)
+ */
+export function iterate(elems, fn) {
+    for (let i = 0, len = elems.length; i < len; i++) {
+        let r = fn(elems[i], i);
+        if (r === true) {
+            break;
+        }
+    }
+}
+/**
+ * 设置或获取节点 data-* 属性
+ * @param elem
+ * @param key data- 后面跟随的值
+ * @param value 如果传递该值表示获取；否则表示设置
+ * @returns
+ */
+export function attr(elem, key, value) {
+    if (value != null) {
+        elem.setAttribute('data-' + key, value);
+    }
+    else {
+        return elem.getAttribute('data-' + key);
+    }
+}
+/**
+ * 获取指定节点的父节点
+ * @param el
+ * @returns
+ */
+export function parent(el) {
+    return el.parentNode;
+}
+/**
+ * 获取隐藏节点的尺寸
+ * @param {string | HTMLElement} hideNode - The node to hide.
+ * @param parent - 添加临时节点的父节点，默认为: body.
+ * @returns The DOMRect of the element.
+ */
+export function queryHideNodeSize(hideNode, parent = document.body) {
+    // 计算折叠菜单的高度
+    let $tmp = document.createElement('div');
+    $tmp.style.cssText = 'position:fixed;left:-1000px;top:-1000px;opacity:0;';
+    let $tmpInner = document.createElement('div');
+    $tmpInner.style.cssText = 'position:relative;';
+    if (typeof hideNode === 'string') {
+        $tmpInner.innerHTML = hideNode;
+    }
+    else {
+        $tmpInner.appendChild(hideNode.cloneNode(true));
+    }
+    $tmp.appendChild($tmpInner);
+    parent.appendChild($tmp);
+    let rect = $tmpInner.children[0].getBoundingClientRect();
+    parent.removeChild($tmp);
+    return { width: rect.width, height: rect.height };
+}

package/lib/file.d.ts

@@ -1,34 +1,31 @@
-declare const _default: {
-    /**
-     * 读取文件内容为JSON格式
-     * @param filepath 读取的文件路径
-     * @returns Promise<unknown>
-     */
-    readJSON<T>(filepath: string): Promise<T>;
-    /**
-     * 写入 JSON 格式的数据到文件
-     * @param file 待写入的文件
-     * @param data 待写入的数据
-     * @param opts 写入配置
-     * @property opts.json 是否写入 JSON 格式的数据，写入数据时对数据进行 JSON 格式化，默认为：true
-     * @property opts.format 是否在写入 json 数据时，将 JSON 数据格式化2个空格写入, 默认为 true
-     */
-    write(file: string, data: any, opts?: {
-        json: boolean;
-        format: boolean;
-    }): Promise<unknown>;
-    /**
-     * 遍历文件夹
-     * @param dir 待遍历的目录
-     * @param callback 遍历到文件后的回调
-     * @param done 遍历完成后的回调
-     */
-    traverseDir(dir: string, callback?: (filename: string) => void, done?: () => void): void;
-    /**
-     * 根据文件的 stat 获取文件的 etag
-     * @param filePath 文件地址
-     * @returns file stat etag
-     */
-    statTag(filePath: string): Promise<string>;
-};
-export = _default;
+/**
+ * 读取文件内容为JSON格式
+ * @param filepath 读取的文件路径
+ * @returns Promise<unknown>
+ */
+export declare function readJSON<T>(filepath: string): Promise<T>;
+/**
+ * 写入 JSON 格式的数据到文件
+ * @param file 待写入的文件
+ * @param data 待写入的数据
+ * @param opts 写入配置
+ * @property opts.json 是否写入 JSON 格式的数据，写入数据时对数据进行 JSON 格式化，默认为：true
+ * @property opts.format 是否在写入 json 数据时，将 JSON 数据格式化2个空格写入, 默认为 true
+ */
+export declare function write(file: string, data: any, opts?: {
+    json: boolean;
+    format: boolean;
+}): Promise<unknown>;
+/**
+ * 遍历文件夹
+ * @param dir 待遍历的目录
+ * @param callback 遍历到文件后的回调
+ * @param done 遍历完成后的回调
+ */
+export declare function traverseDir(dir: string, callback?: (filename: string) => void, done?: () => void): void;
+/**
+ * 根据文件的 stat 获取文件的 etag
+ * @param filePath 文件地址
+ * @returns file stat etag
+ */
+export declare function statTag(filePath: string): Promise<string>;

package/lib/file.js

@@ -1,99 +1,96 @@
-"use strict";
-/** nodejs 文件操作工具类 */
-const path = require('path');
-const fs = require("fs");
-module.exports = {
-    /**
-     * 读取文件内容为JSON格式
-     * @param filepath 读取的文件路径
-     * @returns Promise<unknown>
-     */
-    readJSON(filepath) {
-        return new Promise((resolve, reject) => {
-            fs.readFile(path.resolve(filepath), 'utf-8', (err, data) => {
-                if (err) {
-                    reject(err);
-                }
-                else {
-                    resolve(JSON.parse(data));
-                }
-            });
-        });
-    },
-    /**
-     * 写入 JSON 格式的数据到文件
-     * @param file 待写入的文件
-     * @param data 待写入的数据
-     * @param opts 写入配置
-     * @property opts.json 是否写入 JSON 格式的数据，写入数据时对数据进行 JSON 格式化，默认为：true
-     * @property opts.format 是否在写入 json 数据时，将 JSON 数据格式化2个空格写入, 默认为 true
-     */
-    write(file, data, opts) {
-        return new Promise((resolve, reject) => {
-            let writeData = data.toString();
-            opts = { json: true, format: true, ...(opts || {}) };
-            if (opts.json === true && typeof data === 'object') {
-                writeData = JSON.stringify(data, null, opts.format === true ? 2 : 0);
-            }
-            fs.writeFile(path.resolve(file), writeData, (err) => {
-                if (err) {
-                    reject(err);
-                }
-                else {
-                    resolve(0);
-                }
-            });
-        });
-    },
-    /**
-     * 遍历文件夹
-     * @param dir 待遍历的目录
-     * @param callback 遍历到文件后的回调
-     * @param done 遍历完成后的回调
-     */
-    traverseDir(dir, callback, done) {
-        let t = -1; // 定时任务，简单延迟作为遍历完成计算
-        function list(dr, cb, d) {
-            fs.readdir(path.resolve(dr), { withFileTypes: true }, (err, files) => {
-                if (err && err.errno === -4052) {
-                    // 本身就是文件
-                    if (typeof cb === 'function')
-                        cb(dr);
-                    if (typeof d === 'function')
-                        d(); // 遍历完成
-                }
-                else {
-                    for (let i = 0, len = files.length; i < len; i++) {
-                        const file = files[i];
-                        if (file.isFile()) {
-                            if (typeof cb === 'function')
-                                cb(path.join(dr, file.name));
-                            clearTimeout(t);
-                            t = setTimeout(() => {
-                                setImmediate(() => {
-                                    if (typeof done === 'function') {
-                                        done();
-                                    }
-                                });
-                            }, 10);
-                        }
-                        else {
-                            // 文件夹
-                            list(path.join(dr, file.name), cb, d);
-                        }
-                    }
-                }
-            });
-        }
-        list(dir, callback, done);
-    },
-    /**
-     * 根据文件的 stat 获取文件的 etag
-     * @param filePath 文件地址
-     * @returns file stat etag
-     */
-    async statTag(filePath) {
-        let stat = await fs.promises.stat(filePath);
-        return `${stat.size.toString(16)}-${stat.mtimeMs.toString(16)}`;
-    },
-};
+/** nodejs 文件操作工具类 */
+import path from 'node:path';
+import fs from 'node:fs';
+/**
+ * 读取文件内容为JSON格式
+ * @param filepath 读取的文件路径
+ * @returns Promise<unknown>
+ */
+export function readJSON(filepath) {
+    return new Promise((resolve, reject) => {
+        fs.readFile(path.resolve(filepath), 'utf-8', (err, data) => {
+            if (err) {
+                reject(err);
+            }
+            else {
+                resolve(JSON.parse(data));
+            }
+        });
+    });
+}
+/**
+ * 写入 JSON 格式的数据到文件
+ * @param file 待写入的文件
+ * @param data 待写入的数据
+ * @param opts 写入配置
+ * @property opts.json 是否写入 JSON 格式的数据，写入数据时对数据进行 JSON 格式化，默认为：true
+ * @property opts.format 是否在写入 json 数据时，将 JSON 数据格式化2个空格写入, 默认为 true
+ */
+export function write(file, data, opts) {
+    return new Promise((resolve, reject) => {
+        let writeData = data.toString();
+        opts = { json: true, format: true, ...(opts || {}) };
+        if (opts.json === true && typeof data === 'object') {
+            writeData = JSON.stringify(data, null, opts.format === true ? 2 : 0);
+        }
+        fs.writeFile(path.resolve(file), writeData, (err) => {
+            if (err) {
+                reject(err);
+            }
+            else {
+                resolve(0);
+            }
+        });
+    });
+}
+/**
+ * 遍历文件夹
+ * @param dir 待遍历的目录
+ * @param callback 遍历到文件后的回调
+ * @param done 遍历完成后的回调
+ */
+export function traverseDir(dir, callback, done) {
+    let t = -1; // 定时任务，简单延迟作为遍历完成计算
+    function list(dr, cb, d) {
+        fs.readdir(path.resolve(dr), { withFileTypes: true }, (err, files) => {
+            if (err && err.errno === -4052) {
+                // 本身就是文件
+                if (typeof cb === 'function')
+                    cb(dr);
+                if (typeof d === 'function')
+                    d(); // 遍历完成
+            }
+            else {
+                for (let i = 0, len = files.length; i < len; i++) {
+                    const file = files[i];
+                    if (file.isFile()) {
+                        if (typeof cb === 'function')
+                            cb(path.join(dr, file.name));
+                        clearTimeout(t);
+                        t = setTimeout(() => {
+                            setImmediate(() => {
+                                if (typeof done === 'function') {
+                                    done();
+                                }
+                            });
+                        }, 10);
+                    }
+                    else {
+                        // 文件夹
+                        list(path.join(dr, file.name), cb, d);
+                    }
+                }
+            }
+        });
+    }
+    list(dir, callback, done);
+}
+/**
+ * 根据文件的 stat 获取文件的 etag
+ * @param filePath 文件地址
+ * @returns file stat etag
+ */
+export async function statTag(filePath) {
+    let stat = await fs.promises.stat(filePath);
+    return `${stat.size.toString(16)}-${stat.mtimeMs.toString(16)}`;
+}