ph-utils 0.2.23 → 0.3.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Tenny
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,11 +1,11 @@
-## ph-utils
-
-整理了 js 前后端开发(web + nodejs)时常用的一些工具；[详细文档](https://gitee.com/towardly/ph/wikis/Home?sort_id=4035190)
-
-### 后端(node server)
-
-包含了一些 node 后端开发(web server) 时常用的工具类，包括 `index` 基础工具类(这个类里面的函数同样也适用于前端)、`date` 跟日期相关的工具类、`file` 文件操作相关工具类、`server` 一些只适用于后端的工具(使用了后端的 API 列表)、`validator` 数据验证
-
-### 前端(web)
-
-包含了一些前端网站开发时常用的工具类，包括 `index` 基础工具类(这个类里面的函数同样也适用于前端)、`date` 跟日期相关的工具类、`dom` 浏览器节点操作相关、`web` 一些只适用于前端相关的工具、`validator` 数据验证
+## ph-utils
+
+整理了 js 前后端开发(web + nodejs)时常用的一些工具；[详细文档](https://gitee.com/towardly/ph/wikis/Home?sort_id=4035190)
+
+### 后端(node server)
+
+包含了一些 node 后端开发(web server) 时常用的工具类，包括 `index` 基础工具类(这个类里面的函数同样也适用于前端)、`date` 跟日期相关的工具类、`file` 文件操作相关工具类、`server` 一些只适用于后端的工具(使用了后端的 API 列表)、`validator` 数据验证
+
+### 前端(web)
+
+包含了一些前端网站开发时常用的工具类，包括 `index` 基础工具类(这个类里面的函数同样也适用于前端)、`date` 跟日期相关的工具类、`dom` 浏览器节点操作相关、`web` 一些只适用于前端相关的工具、`validator` 数据验证

package/lib/date.d.ts

@@ -1,34 +1,55 @@
-/**
- * 将日期格式化为指定形式的字符串
- * @param date      日期
- * @param pattern   格式化字符串 yyyy - 年, mm - 月, dd - 日, HH - 小时, MM - 分钟, ss - 秒
- */
-export declare function format(date?: Date | string | number, pattern?: string): string;
-/**
- * 将指定的参数解析为日期对象(Date)
- * 参考 dayjs 实现, 也可以参考 https://github.com/nomiddlename/date-format
- * @param date 待解析的日期参数
- */
-export declare function parse(date?: Date | string | number): Date;
-/**
- * 设置日期的开始或者结束的点
- * @param {Object} date 日期，能够被 parse 解析的日期
- * @param {String} unit 单位，H Hours, 默认为 H
- * @param {Boolean} isEnd true则为 endOf
- */
-export declare function startOf(date?: Date | string | number, unit?: string, isEnd?: boolean): Date;
-/**
- * 日期加上指定时间后的日期
- * @param date 指定的日期
- * @param num  需要添加的数字, 如果这个参数传递一个小于0的数字，则就是日期减去相应的数字
- * @param unit 需要添加的单位，date - 加减天数
- */
-export declare function add(date: Date | string | number | null, num: number, unit: string): Date;
-/**
- * 日期加上指定时间后的日期
- * @param date    指定的日期, 传递为 null ，则表示为当前日期
- * @param num     需要添加的数字, 如果这个参数传递一个小于0的数字，则就是日期减去相应的数字
- * @param unit    需要添加的单位，date - 加减天数
- * @param fmt     如果传递了格式化的单位，则返回格式化后的日期, 格式化字符串 yyyy - 年, mm - 月, dd - 日, HH - 小时, MM - 分钟, ss - 秒
- */
-export declare function add(date: Date | string | number | null, num: number, unit: string, fmt: string): string;
+/**
+ * 将日期格式化为指定形式的字符串
+ * @param date      日期
+ * @param pattern   格式化字符串 yyyy - 年, mm - 月, dd - 日, HH - 小时, MM - 分钟, ss - 秒
+ */
+export declare function format(date?: Date | string | number, pattern?: string): string;
+/**
+ * 将指定的参数解析为日期对象(Date)
+ * 参考 dayjs 实现, 也可以参考 https://github.com/nomiddlename/date-format
+ * @param date 待解析的日期参数
+ */
+export declare function parse(date?: Date | string | number): Date;
+/**
+ * 设置日期的开始或者结束的点
+ * @param {Object} date 日期，能够被 parse 解析的日期
+ * @param {String} unit 单位，Date|date, 默认为 Date
+ * @param {Boolean} isEnd true则为 endOf
+ */
+export declare function dateOf(date?: Date | string | number, unit?: string, isEnd?: boolean): Date;
+/**
+ * 设置日期的开始的点
+ * @param date 日期，能够被 parse 解析的日期
+ * @param unit 单位，Date|date, 默认为 Date
+ * @returns
+ */
+export declare function startOf(date?: Date | string | number, unit?: string): Date;
+/**
+ * 设置日期的结束点
+ * @param date 日期，能够被 parse 解析的日期
+ * @param unit 单位，Date|date, 默认为 Date
+ * @returns
+ */
+export declare function endOf(date?: Date | string | number, unit?: string): Date;
+/**
+ * 获取时间戳
+ * @param ctime 时间
+ * @param unit 时间戳长度
+ * @returns
+ */
+export declare function timeStamp(ctime?: Date | string | number, unit?: 's' | 'ms'): number;
+/**
+ * 日期加上指定时间后的日期
+ * @param date 指定的日期
+ * @param num  需要添加的数字, 如果这个参数传递一个小于0的数字，则就是日期减去相应的数字
+ * @param unit 需要添加的单位，date - 加减天数
+ */
+export declare function add(date: Date | string | number | null, num: number, unit: string): Date;
+/**
+ * 日期加上指定时间后的日期
+ * @param date    指定的日期, 传递为 null ，则表示为当前日期
+ * @param num     需要添加的数字, 如果这个参数传递一个小于0的数字，则就是日期减去相应的数字
+ * @param unit    需要添加的单位，date - 加减天数
+ * @param fmt     如果传递了格式化的单位，则返回格式化后的日期, 格式化字符串 yyyy - 年, mm - 月, dd - 日, HH - 小时, MM - 分钟, ss - 秒
+ */
+export declare function add(date: Date | string | number | null, num: number, unit: string, fmt: string): string;

package/lib/date.js

@@ -1,126 +1,203 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.add = exports.startOf = exports.parse = exports.format = void 0;
-/**
- * node 和 web 端日期处理工具类
- */
-// 配置日期格式的正则表达式
-const REGEX_FORMAT = /yy(?:yy)?|([HMmds])\1?/g;
-// 由于 Date.parse() 不能正确解析 yyyy-dd-mm 格式的日期, 所以匹配手动解析
-const REGEX_PARSE = /^(\d{4})-?(\d{1,2})-?(\d{0,2})[^0-9]*(\d{1,2})?:?(\d{1,2})?:?(\d{1,2})?.?(\d{1,3})?$/;
-/**
- * 不足位数, 前位补 0
- * @param s 日期数字
- * @param l 截取位数
- * @returns {string}  补0后的日期数字
- */
-function p(s, l = 2) {
-    /*
-     * 由于年份最多为4为，所以前面先添3个0
-     * slice() 从后开始提前字符串
-     */
-    return ('000' + s).slice(l * -1);
-}
-function getUnit(unit) {
-    return unit.substring(0, 1).toUpperCase() + unit.substring(1);
-}
-/**
- * 将日期格式化为指定形式的字符串
- * @param date      日期
- * @param pattern   格式化字符串 yyyy - 年, mm - 月, dd - 日, HH - 小时, MM - 分钟, ss - 秒
- */
-function format(date, pattern = 'yyyy-mm-dd HH:MM') {
-    date = parse(date);
-    let d = date.getDate();
-    let y = date.getFullYear();
-    let m = date.getMonth();
-    let H = date.getHours();
-    let M = date.getMinutes();
-    let s = date.getSeconds();
-    let flags = {
-        yy: p(y),
-        yyyy: y,
-        m: m + 1,
-        mm: p(m + 1),
-        d: d,
-        dd: p(d),
-        H: H,
-        HH: p(H),
-        M: M,
-        MM: p(M),
-        s: s,
-        ss: p(s),
-    };
-    if (pattern != null) {
-        return pattern.replace(REGEX_FORMAT, (flag) => {
-            if (flag in flags) {
-                return flags[flag];
-            }
-            return flag;
-        });
-    }
-    return String(date.getTime());
-}
-exports.format = format;
-/**
- * 将指定的参数解析为日期对象(Date)
- * 参考 dayjs 实现, 也可以参考 https://github.com/nomiddlename/date-format
- * @param date 待解析的日期参数
- */
-function parse(date) {
-    if (date == null)
-        return new Date();
-    if (date instanceof Date)
-        return date;
-    if (typeof date === 'string' && !/Z$/i.test(date)) {
-        const d = date.match(REGEX_PARSE);
-        if (d) {
-            return new Date(d[1], d[2] - 1, d[3] || 1, d[4] || 0, d[5] || 0, d[6] || 0, d[7] || 0);
-        }
-    }
-    return new Date(date);
-}
-exports.parse = parse;
-/**
- * 设置日期的开始或者结束的点
- * @param {Object} date 日期，能够被 parse 解析的日期
- * @param {String} unit 单位，H Hours, 默认为 H
- * @param {Boolean} isEnd true则为 endOf
- */
-function startOf(date, unit, isEnd = false) {
-    const argumentStart = [0, 0, 0, 0];
-    const argumentEnd = [23, 59, 59, 999];
-    date = parse(date);
-    let u = getUnit(unit || 'Hours');
-    let fn = 'set' + u;
-    let args = isEnd === true ? argumentEnd : argumentStart;
-    Date.prototype[fn].apply(date, args);
-    return date;
-}
-exports.startOf = startOf;
-/**
- * 日期加上指定时间后的日期
- * @param date  指定的日期
- * @param num   需要添加的数字, 如果这个参数传递一个小于0的数字，则就是日期减去相应的数字
- * @param unit  需要添加的单位，date - 加减天数
- * @param fmt   可选参数，如果传递了格式化的单位，则返回格式化后的日期, 格式化字符串 yyyy - 年, mm - 月, dd - 日, HH - 小时, MM - 分钟, ss - 秒
- * @returns {Date | string} 如果传递了 fmt 参数，则返回 string，否则返回 Date
- */
-function add(date, num, unit, fmt) {
-    let sdate = new Date();
-    if (date != null) {
-        sdate = parse(date);
-    }
-    unit = getUnit(unit);
-    let fn = 'set' + unit;
-    let gn = 'get' + unit;
-    let oldValue = Date.prototype[gn].apply(sdate);
-    Date.prototype[fn].apply(sdate, [oldValue + num]);
-    if (typeof fmt === 'string') {
-        return format(sdate, fmt);
-    }
-    else {
-        return sdate;
-    }
-}
-exports.add = add;
+/**
+ * node 和 web 端日期处理工具类
+ */
+// 配置日期格式的正则表达式
+const REGEX_FORMAT = /yy(?:yy)?|([HMmds])\1?/g;
+// 由于 Date.parse() 不能正确解析 yyyy-dd-mm 格式的日期, 所以匹配手动解析
+const REGEX_PARSE = /^(\d{4})-?(\d{1,2})-?(\d{0,2})[^0-9]*(\d{1,2})?:?(\d{1,2})?:?(\d{1,2})?.?(\d{1,3})?$/;
+const ofArgs = {
+    start: [0, 0, 1, 0, 0, 0, 0],
+    end: [0, 11, -2, 23, 59, 59, 999],
+};
+const units = {
+    Date: ['date', 'Date', 'day', 'Day', 'D', 'd'],
+    Month: ['Month', 'month', 'm'],
+    Year: ['Year', 'year', 'y'],
+    Hours: ['Hours', 'hours', 'H'],
+    Minutes: ['Minutes', 'Minute', 'minute', 'minutes', 'M'],
+    Seconds: ['Seconds', 'seconds', 'Second', 'second', 's'],
+    Milliseconds: ['Milliseconds', 'Millisecond', 'milliseconds', 'illisecond', 'S'],
+};
+/**
+ * 不足位数, 前位补 0
+ * @param s 日期数字
+ * @param l 截取位数
+ * @returns {string}  补0后的日期数字
+ */
+function p(s, l = 2) {
+    /*
+     * 由于年份最多为4为，所以前面先添3个0
+     * slice() 从后开始提前字符串
+     */
+    return ('000' + s).slice(l * -1);
+}
+/**
+ * 将单位转换为首字母大写, 例如：hours -> Hours
+ * @param unit hours
+ * @returns
+ */
+function getUnit(unit) {
+    let period = null;
+    for (let [key, value] of Object.entries(units)) {
+        if (value.includes(unit)) {
+            period = key;
+            break;
+        }
+    }
+    if (period == null) {
+        throw new Error(`Invalid unit: ${unit}`);
+    }
+    return period;
+}
+/**
+ * 获取指定日期某个月的最后一天
+ * @param date  日期
+ * @param month 月份, 如果不传, 则当前月的最后一天
+ * @returns
+ */
+function getLastDayOfYear(date, month) {
+    // 获取下个月的第一天
+    const lastDate = new Date(date.getFullYear(), (month || date.getMonth()) + 1, 1);
+    // 将下个月的第一天的日期减去一天，得到当前月的最后一天
+    lastDate.setDate(lastDate.getDate() - 1);
+    // 返回最后一天的日期
+    return lastDate.getDate();
+}
+/**
+ * 将日期格式化为指定形式的字符串
+ * @param date      日期
+ * @param pattern   格式化字符串 yyyy - 年, mm - 月, dd - 日, HH - 小时, MM - 分钟, ss - 秒
+ */
+export function format(date, pattern = 'yyyy-mm-dd HH:MM') {
+    // eslint-disable-next-line
+    date = parse(date);
+    let d = date.getDate();
+    let y = date.getFullYear();
+    let m = date.getMonth();
+    let H = date.getHours();
+    let M = date.getMinutes();
+    let s = date.getSeconds();
+    let flags = {
+        yy: p(y),
+        yyyy: y,
+        m: m + 1,
+        mm: p(m + 1),
+        d: d,
+        dd: p(d),
+        H: H,
+        HH: p(H),
+        M: M,
+        MM: p(M),
+        s: s,
+        ss: p(s),
+    };
+    if (pattern != null) {
+        return pattern.replace(REGEX_FORMAT, (flag) => {
+            if (flag in flags) {
+                return flags[flag];
+            }
+            return flag;
+        });
+    }
+    return String(date.getTime());
+}
+/**
+ * 将指定的参数解析为日期对象(Date)
+ * 参考 dayjs 实现, 也可以参考 https://github.com/nomiddlename/date-format
+ * @param date 待解析的日期参数
+ */
+export function parse(date) {
+    if (date == null)
+        return new Date();
+    if (date instanceof Date)
+        return date;
+    if (typeof date === 'string' && !/Z$/i.test(date)) {
+        const d = date.match(REGEX_PARSE);
+        if (d) {
+            return new Date(d[1], d[2] - 1, d[3] || 1, d[4] || 0, d[5] || 0, d[6] || 0, d[7] || 0);
+        }
+    }
+    if (typeof date === 'number') {
+        return new Date(date <= 9999999999 ? date * 1000 : date);
+    }
+    return new Date();
+}
+/**
+ * 设置日期的开始或者结束的点
+ * @param {Object} date 日期，能够被 parse 解析的日期
+ * @param {String} unit 单位，Date|date, 默认为 Date
+ * @param {Boolean} isEnd true则为 endOf
+ */
+export function dateOf(date, unit, isEnd = false) {
+    /* 如果是设置某一天的开始时刻, 就需要将时、分、秒、毫秒设置为0，依次类推设置 */
+    const periods = ['Year', 'Month', 'Date', 'Hours', 'Minutes', 'Seconds', 'Milliseconds'];
+    let index = periods.indexOf(getUnit(unit || 'Date'));
+    const clone = parse(date);
+    index++;
+    const setValues = ofArgs[isEnd === true ? 'end' : 'start'];
+    for (const len = periods.length; index < len; index++) {
+        let value = setValues[index];
+        if (value === -2) {
+            // 设置为某个月的最后一天的日期
+            value = getLastDayOfYear(clone);
+        }
+        Date.prototype['set' + periods[index]].apply(clone, [setValues[index]]);
+    }
+    return clone;
+}
+/**
+ * 设置日期的开始的点
+ * @param date 日期，能够被 parse 解析的日期
+ * @param unit 单位，Date|date, 默认为 Date
+ * @returns
+ */
+export function startOf(date, unit) {
+    return dateOf(date, unit);
+}
+/**
+ * 设置日期的结束点
+ * @param date 日期，能够被 parse 解析的日期
+ * @param unit 单位，Date|date, 默认为 Date
+ * @returns
+ */
+export function endOf(date, unit) {
+    return dateOf(date, unit, true);
+}
+/**
+ * 获取时间戳
+ * @param ctime 时间
+ * @param unit 时间戳长度
+ * @returns
+ */
+export function timeStamp(ctime, unit = 's') {
+    let tm = parse(ctime).getTime();
+    return unit === 's' ? Math.floor(tm / 1000) : tm;
+}
+/**
+ * 日期加上指定时间后的日期
+ * @param date  指定的日期
+ * @param num   需要添加的数字, 如果这个参数传递一个小于0的数字，则就是日期减去相应的数字
+ * @param unit  需要添加的单位，date - 加减天数
+ * @param fmt   可选参数，如果传递了格式化的单位，则返回格式化后的日期, 格式化字符串 yyyy - 年, mm - 月, dd - 日, HH - 小时, MM - 分钟, ss - 秒
+ * @returns {Date | string} 如果传递了 fmt 参数，则返回 string，否则返回 Date
+ */
+export function add(date, num, unit, fmt) {
+    let sdate = new Date();
+    if (date != null) {
+        sdate = parse(date);
+    }
+    // eslint-disable-next-line
+    unit = getUnit(unit);
+    let fn = 'set' + unit;
+    let gn = 'get' + unit;
+    // @ts-ignore
+    let oldValue = Date.prototype[gn].apply(sdate);
+    // @ts-ignore
+    Date.prototype[fn].apply(sdate, [oldValue + num]);
+    if (typeof fmt === 'string') {
+        return format(sdate, fmt);
+    }
+    else {
+        return sdate;
+    }
+}

package/lib/dom.d.ts

@@ -1,92 +1,92 @@
-/**
- * 根据选择器获取节点
- * @param {string} selector 选择器
- */
-export declare function elem(selector: string | HTMLElement, dom?: HTMLElement): NodeListOf<HTMLElement> | HTMLElement[];
-/**
- * 为节点添加 class
- * @param {HTMLElement} elem 待添加 class 的节点
- * @param {string} clazz     需要添加的 class
- */
-export declare function addClass(elem: HTMLElement, clazz: string): void;
-/**
- * 节点移除 class
- * @param {HTMLElement} elem 待移除 class 的节点
- * @param {string} clazz     需要移除的 class
- */
-export declare function removeClass(elem: HTMLElement, clazz: string): void;
-/**
- * 判断节点是否包含某个 class
- * @param elem  待判断 class 的节点
- * @param clazz 待判断的 class
- * @returns
- */
-export declare function hasClass(elem: HTMLElement, clazz: string): boolean;
-/**
- * 为节点添加 transition 属性，包括浏览器前缀
- * @param {HTMLElement} element 需要添加 css Transition 属性的节点
- * @param {string}      value   css transition 值
- */
-export declare function transition(element: HTMLElement, value: string): void;
-/**
- * 为节点添加 transform 属性，包括浏览器前缀
- * @param {HTMLElement} element  需要添加 css transform 属性的节点
- * @param {string}      value     css transform 值
- */
-export declare function transform(element: HTMLElement, value: string): void;
-/**
- * 为节点添加事件处理
- * @param {HTMLElement} element   添加事件的节点
- * @param {string}      listener  事件名称
- * @param {function}    event     事件处理函数
- * @param {boolean}     onceOrConfig  是否是只运行一次的处理函数或者配置，其中 eventFlag 为 string，如果配置该项，则表明为委托事件
- */
-export declare function on<T extends Event>(element: HTMLElement, listener: string, fn: (e: T, target?: HTMLElement, flag?: string) => void, once?: boolean | {
-    once?: boolean;
-    eventFlag?: string;
-    eventStop?: boolean;
-}): void;
-/**
- * 设置或获取节点的 innerHTML 属性
- * @param element
- * @param htmlstr 可选，如果传递该参数，则表示设置；否则表示获取
- * @returns
- */
-export declare function html(element: HTMLElement, htmlstr?: string): string;
-/**
- * 设置或获取节点的 textContent 属性
- * @param element
- * @param textstr 可选，如果传递该参数，则表示设置；否则表示获取
- * @returns
- */
-export declare function text(element: HTMLElement, textstr?: string): string;
-/**
- * 节点列表遍历
- * @param elems
- * @param fn 遍历到节点时的回调，回调第一个参数为遍历到的节点，第2个参数为 index；如果回调函数返回 true，则会终止遍历(break)
- */
-export declare function iterate(elems: NodeList | HTMLElement[], fn: (el: HTMLElement, index: number) => any): void;
-/**
- * 设置或获取节点 data-* 属性
- * @param elem
- * @param key data- 后面跟随的值
- * @param value 如果传递该值表示获取；否则表示设置
- * @returns
- */
-export declare function attr(elem: HTMLElement, key: string, value?: string): string;
-/**
- * 获取指定节点的父节点
- * @param el
- * @returns
- */
-export declare function parent(el: HTMLElement): HTMLElement;
-/**
- * 获取隐藏节点的尺寸
- * @param {string | HTMLElement} hideNode - The node to hide.
- * @param parent - 添加临时节点的父节点，默认为: body.
- * @returns The DOMRect of the element.
- */
-export declare function queryHideNodeSize(hideNode: string | HTMLElement, parent?: HTMLElement): {
-    width: number;
-    height: number;
-};
+/**
+ * 根据选择器获取节点
+ * @param {string} selector 选择器
+ */
+export declare function elem(selector: string | HTMLElement, dom?: HTMLElement): NodeListOf<HTMLElement> | HTMLElement[];
+/**
+ * 为节点添加 class
+ * @param {HTMLElement} elem 待添加 class 的节点
+ * @param {string} clazz     需要添加的 class
+ */
+export declare function addClass(elem: HTMLElement, clazz: string): void;
+/**
+ * 节点移除 class
+ * @param {HTMLElement} elem 待移除 class 的节点
+ * @param {string} clazz     需要移除的 class
+ */
+export declare function removeClass(elem: HTMLElement, clazz: string): void;
+/**
+ * 判断节点是否包含某个 class
+ * @param elem  待判断 class 的节点
+ * @param clazz 待判断的 class
+ * @returns
+ */
+export declare function hasClass(elem: HTMLElement, clazz: string): boolean;
+/**
+ * 为节点添加 transition 属性，包括浏览器前缀
+ * @param {HTMLElement} element 需要添加 css Transition 属性的节点
+ * @param {string}      value   css transition 值
+ */
+export declare function transition(element: HTMLElement, value: string): void;
+/**
+ * 为节点添加 transform 属性，包括浏览器前缀
+ * @param {HTMLElement} element  需要添加 css transform 属性的节点
+ * @param {string}      value     css transform 值
+ */
+export declare function transform(element: HTMLElement, value: string): void;
+/**
+ * 为节点添加事件处理
+ * @param {HTMLElement} element   添加事件的节点
+ * @param {string}      listener  事件名称
+ * @param {function}    event     事件处理函数
+ * @param {boolean}     onceOrConfig  是否是只运行一次的处理函数或者配置，其中 eventFlag 为 string，如果配置该项，则表明为委托事件
+ */
+export declare function on<T extends Event>(element: HTMLElement, listener: string, fn: (e: T, target?: HTMLElement, flag?: string) => void, once?: boolean | {
+    once?: boolean;
+    eventFlag?: string;
+    eventStop?: boolean;
+}): void;
+/**
+ * 设置或获取节点的 innerHTML 属性
+ * @param element
+ * @param htmlstr 可选，如果传递该参数，则表示设置；否则表示获取
+ * @returns
+ */
+export declare function html(element: HTMLElement, htmlstr?: string): string | undefined;
+/**
+ * 设置或获取节点的 textContent 属性
+ * @param element
+ * @param textstr 可选，如果传递该参数，则表示设置；否则表示获取
+ * @returns
+ */
+export declare function text(element: HTMLElement, textstr?: string): string | null | undefined;
+/**
+ * 节点列表遍历
+ * @param elems
+ * @param fn 遍历到节点时的回调，回调第一个参数为遍历到的节点，第2个参数为 index；如果回调函数返回 true，则会终止遍历(break)
+ */
+export declare function iterate(elems: NodeList | HTMLElement[], fn: (el: HTMLElement, index: number) => any): void;
+/**
+ * 设置或获取节点 data-* 属性
+ * @param elem
+ * @param key data- 后面跟随的值
+ * @param value 如果传递该值表示获取；否则表示设置
+ * @returns
+ */
+export declare function attr(elem: HTMLElement, key: string, value?: string): string | null | undefined;
+/**
+ * 获取指定节点的父节点
+ * @param el
+ * @returns
+ */
+export declare function parent(el: HTMLElement): HTMLElement;
+/**
+ * 获取隐藏节点的尺寸
+ * @param {string | HTMLElement} hideNode - The node to hide.
+ * @param parent - 添加临时节点的父节点，默认为: body.
+ * @returns The DOMRect of the element.
+ */
+export declare function queryHideNodeSize(hideNode: string | HTMLElement, parent?: HTMLElement): {
+    width: number;
+    height: number;
+};