@polyv/utils 1.8.0-rc.1 → 2.0.0-beta.3

package/README.md

@@ -5,18 +5,20 @@
 ## 安装
 
 ```
-npm install @polyv/utils
+npm install @polyv/utils@next
 ```
 
-NPM 包同时提供了源文件（ES 2015 Modules）以及构建后的文件（CommonJS Modules），分别位于 src 和 dist 两个子文件夹。它们使用上的优缺点和区别在于：
+NPM 包同时提供了 ES 模块以及 CommonJS 模块，分别位于 `dist/es` 和 `dist/cjs` 两个文件夹。它们使用上的区别和优缺点在于：
 
-| 文件类型 | Tree shaking | 自行编写构建逻辑 |
+| 模块类型 | Tree shaking | Babel 编译 |
 | --- | --- | --- |
-| 源文件 | 有效，只有用到的代码会被打包 | 需要 |
-| 构建后文件 | 无效，依赖的文件会被整个打包 | 不需要 |
+| ES 模块 | 有效，只有用到的代码会被打包 | 需要 |
+| CommonJS 模块 | 无效，依赖的文件会被整个打包 | 不需要 |
 
 
-## 在基于 Vue.js 框架的项目中使用
+## 使用
+
+### 在基于 Vue.js 框架的项目中使用
 
 以 Vue CLI 3.x 创建的项目为例，编辑 vue.config.js 增加相关配置：
 
@@ -28,12 +30,12 @@ module.exports = {
     resolve: {
       alias: {
         // 配置别名缩短引用路径
-        '@utils': path.resolve(__dirname, './node_modules/@polyv/utils/src')
+        '@utils': path.resolve(__dirname, './node_modules/@polyv/utils/dist/es')
       }
     }
   },
 
-  // 需要 Babel 转译
+  // ES 模块需要 Babel 转译
   transpileDependencies: [
     '@polyv/utils'
   ]
@@ -47,7 +49,7 @@ import { cutStr } from '@utils/string';
 import Countdown from '@utils/countdown';
 ```
 
-## 在基于 Nuxt.js 框架的项目中使用
+### 在基于 Nuxt.js 框架的项目中使用
 
 以 create-nuxt-app 创建的项目为例，编辑 nuxt.config.js 增加相关配置：
 
@@ -56,22 +58,16 @@ module.exports = {
   // 省略其他配置
 
   build: {
-    // 需要 Babel 转译
+    // ES 模块需要 Babel 转译
     transpile: [
       '@polyv/utils'
     ]
   },
 
   extend(config, ctx) {
-    // 浏览器端需要 polyfill
-    if (ctx.isClient) {
-      config.entry = config.entry || {};
-      config.entry.polyfill = ['core-js'];
-    }
-
     // 配置别名缩短引用路径
     config.resolve.alias['@utils'] = path.resolve(
-      __dirname, './node_modules/@polyv/utils/src'
+      __dirname, './node_modules/@polyv/utils/dist/es'
     );
   }
 };
@@ -81,7 +77,7 @@ module.exports = {
 
 ``` javascript
 import { cutStr } from '@utils/string';
-import Countdown from '@utils/countdown';
+import { Countdown } from '@utils/countdown';
 ```
 
 ## 兼容性
@@ -90,4 +86,23 @@ import Countdown from '@utils/countdown';
 - Android >= 5 (未测试更低版本)
 
 ## 其他
-- [API 文档](https://polyv.github.io/fed-common-utils/1.x/index.html)
+- [API 文档（1.6.3）](https://polyv.github.io/fed-common-utils/1.6.3/index.html)
+- [API 文档（2.x）](https://polyv.github.io/fed-common-utils/2.x/index.html)
+
+## 2.0.0 版本的变更
+
+2.0.0 与 1.x 相比有较大的变更，如需升级，请参阅下方变更说明：
+
+- 模块变更：
+  - 原 lang 模块已移除，可以使用 [@just4/util](https://www.npmjs.com/package/@just4/util) 或 [lodash-es](https://www.npmjs.com/package/lodash-es) 代替。
+  - 原 browser 模块已移除，可以使用 [@just4/ua-info](https://www.npmjs.com/package/@just4/ua-info) 代替。
+  - 原 cookie 模块已移除，可以使用 [@just4/cookie](https://www.npmjs.com/package/@just4/cookie) 代替。
+  - 原 polling 模块已移除，可以使用 [@just4/polling](https://www.npmjs.com/package/@just4/polling) 代替。
+  - 原 storage 模块已移除，可以使用 [@just4/storage](https://www.npmjs.com/package/@just4/storage) 代替。
+- 部分 API 的变更：
+  - boolean 模块的 `ynToBool` 支持指定默认值。
+  - countdown 模块的 `Countdown` 类增加 `pause` 方法。
+  - string 模块的 `cutStr`、`strLen` 两个方法的选项，不再支持 `mode` 属性。
+  - string 模块新增 `uuidV4` 方法。
+  - validate 模块的 `isPhoneNO` 方法改名为 `isChsPhoneNO`。
+- CommonJS 模块的路径是 dist/cjs（原来是 dist），ES 模块的路径是 dist/es（原来是 src）。

package/dist/cjs/boolean.d.ts

@@ -0,0 +1,45 @@
+/**
+ * 本模块提供布尔值处理相关方法。
+ * @packageDocumentation
+ */
+/**
+ * Y 或者 N。
+ */
+export declare type YOrN = 'Y' | 'N';
+/**
+ * 布尔值转换为 Y 或者 N。
+ * @param value 布尔值。
+ * @return Y 或者 N。
+ */
+export declare function boolToYN(value: boolean): YOrN;
+/**
+ * Y 或者 N 转换为布尔值。
+ * @param value Y 或者 N。
+ * @param defaultValue 当 value 为非法值时的默认值。
+ * @return 布尔值。
+ */
+export declare function ynToBool(value: YOrN, defaultValue?: YOrN): boolean;
+/**
+ * 检查指定数组元素的值是否都为 Y。
+ * @param values 指定数组。
+ * @return 指定数组元素的值是否都为 Y。
+ */
+export declare function allY(values: YOrN[]): boolean;
+/**
+ * 检查指定数组元素的值是否至少有一个为 Y。
+ * @param values 指定数组。
+ * @return 指定数组元素的值是否至少有一个为 Y。
+ */
+export declare function someY(values: YOrN[]): boolean;
+/**
+ * 检查指定数组元素的值是否都为 N。
+ * @param values 指定数组。
+ * @return 指定数组元素的值是否都为 N。
+ */
+export declare function allN(values: YOrN[]): boolean;
+/**
+ * 检查指定数组元素的值是否至少有一个为 N。
+ * @param values 指定数组。
+ * @return 指定数组元素的值是否至少有一个为 N。
+ */
+export declare function someN(values: YOrN[]): boolean;

package/dist/cjs/boolean.js

@@ -0,0 +1 @@
+"use strict";function boolToYN(o){if("boolean"!=typeof o)throw new Error("The value argument must be a boolean type");return o?"Y":"N"}function ynToBool(o,e){var r=String(o).toUpperCase();if("Y"!==r&&"N"!==r){if(null==e)throw new Error('The value argument must be "Y" or "N"');r=String(e).toUpperCase()}return"Y"===r}function allY(o){return o.every((function(o){return ynToBool(o)}))}function someY(o){return o.some((function(o){return ynToBool(o)}))}function allN(o){return o.every((function(o){return!ynToBool(o)}))}function someN(o){return o.some((function(o){return!ynToBool(o)}))}Object.defineProperty(exports,"__esModule",{value:!0}),exports.someN=exports.allN=exports.someY=exports.allY=exports.ynToBool=exports.boolToYN=void 0,exports.boolToYN=boolToYN,exports.ynToBool=ynToBool,exports.allY=allY,exports.someY=someY,exports.allN=allN,exports.someN=someN;

package/dist/cjs/countdown.d.ts

@@ -0,0 +1,97 @@
+/**
+ * 本模块提供倒计时功能。
+ * @packageDocumentation
+ */
+/**
+ * 表示剩余时长。
+ */
+export interface IRemaining {
+    /**
+     * 剩余天数。
+     */
+    days: number;
+    /**
+     * 剩余小时数。
+     */
+    hours: number;
+    /**
+     * 剩余分钟数。
+     */
+    minutes: number;
+    /**
+     * 剩余秒数。
+     */
+    seconds: number;
+    /**
+     * 剩余总时间的毫秒表示。
+     */
+    totalMsecs: number;
+}
+/**
+ * 倒计时的回调函数。
+ */
+export interface ICountdownCallback {
+    (remaining: IRemaining): void;
+}
+/**
+ * 倒计时类。
+ * @example
+ * ```javascript
+ * const countdown = new Countdown(60, (remaining) => {
+ *   console.dir(remaining);
+ * });
+ * countdown.start();
+ * ```
+ */
+export declare class Countdown {
+    /**
+     * 倒计时总时间的毫秒表示。
+     */
+    protected readonly _totalMSecs: number;
+    /**
+     * 倒计时回调函数。
+     */
+    protected readonly _cb: ICountdownCallback;
+    /**
+     * 倒计时剩余时间的毫秒表示。
+     */
+    protected _remainingMSecs?: number;
+    /**
+     * 当前正在使用的倒计时秒数。
+     */
+    protected _usingMSecs?: number;
+    /**
+     * 倒计时开始时间的毫秒级时间戳，为 undefined 时表示倒计时未开始。
+     */
+    protected _startTime?: number;
+    /**
+     * 倒计时定时器 id。
+     */
+    protected _timerId?: number;
+    /**
+     * 倒计时类构造函数。
+     * @param secs 倒计时总秒数。
+     * @param cb 剩余时长的回调函数，正常情况下大概 1 秒回调一次。
+     */
+    constructor(totalSecs: number, cb: ICountdownCallback);
+    /**
+     * 倒计时的具体操作。
+     */
+    protected _exec(): void;
+    /**
+     * 开始倒计时。
+     */
+    start(): void;
+    /**
+     * 中断倒计时。
+     */
+    protected _break(): void;
+    /**
+     * 停止倒计时。如果再次调用 start，则重新开始倒计时。
+     */
+    stop(): void;
+    /**
+     * 暂停倒计时。如果再次调用 start，则继续未完成的倒计时。
+     */
+    pause(): void;
+}

package/dist/cjs/countdown.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.Countdown=void 0;var computes=[{divisor:86400,unit:"days"},{divisor:3600,unit:"hours"},{divisor:60,unit:"minutes"},{divisor:1,unit:"seconds"}],Countdown=function(){function t(t,i){if(t|=0,isNaN(t))throw new Error("Total seconds must be a number");this._totalMSecs=1e3*t,this._cb=i}return t.prototype._exec=function(){var t=this;if(this._startTime&&null!=this._usingMSecs){var i=Math.max(0,this._usingMSecs-(Date.now()-this._startTime));if(i>0&&setTimeout((function(){t._exec()}),1e3),this._remainingMSecs=i,i>=0){var s={days:0,hours:0,minutes:0,seconds:0,totalMsecs:i};i=Math.round(i/1e3),computes.forEach((function(t,e){s[t.unit]=i/t.divisor,e===computes.length-1?s[t.unit]=Math.round(s[t.unit]):(s[t.unit]=Math.floor(s[t.unit]),i%=t.divisor)})),this._cb(s)}}},t.prototype.start=function(){null==this._usingMSecs&&(this._usingMSecs=this._totalMSecs),this._usingMSecs<=0||(this._startTime=Date.now(),this._exec())},t.prototype._break=function(){this._timerId&&clearTimeout(this._timerId),this._startTime=void 0},t.prototype.stop=function(){this._break(),this._usingMSecs=this._totalMSecs},t.prototype.pause=function(){this._break(),this._usingMSecs=this._remainingMSecs},t}();exports.Countdown=Countdown;

package/dist/cjs/date.d.ts

@@ -0,0 +1,44 @@
+/**
+ * 本模块提供日期和时间处理的相关方法。
+ * @packageDocumentation
+ */
+/**
+ * 格式化日期。
+ * @param date 日期对象或时间戳（毫秒）。
+ * @param formation 格式。
+ * @return 格式化结果。
+ * @example
+ * ```javascript
+ * formatDate(new Date(2018, 9, 8, 8, 50, 56), 'YYYY-MM-DD hh:mm:ss'); // '2018-10-08 08:50:56'
+ * ```
+ */
+export declare function formatDate(date: number | Date, formation: string): string;
+/**
+ * 秒数格式化配置。
+ */
+export interface FormatSecondsOptions {
+    /**
+     * 段数，2 或者 3。
+     * 为 3 时，格式化样式为「时:分:秒」。
+     * 为 2 时，格式化样式为「分:秒」。
+     */
+    segments?: number;
+    /**
+     * 每一段数字的最小位数，不足位数时补 0。
+     */
+    digits?: number;
+}
+/**
+ * 把秒数格式化成“时:分:秒”格式。
+ * @param secs 秒数。
+ * @param options 格式化配置。
+ * @return 格式化结果。
+ * @example
+ * ```javascript
+ * formatSeconds(3682); // '61:22'
+ * formatSeconds(82); // '01:22'
+ * formatSeconds(82, { segments: 3 }); // '00:01:22'
+ * formatSeconds(3682, { segments: 3, digits: 1 }); // '1:1:22'
+ * ```
+ */
+export declare function formatSeconds(secs: number, options?: FormatSecondsOptions): string;

package/dist/cjs/date.js

@@ -0,0 +1 @@
+"use strict";function ensureDate(e){return"object"!=typeof e&&(e=new Date(e)),e}function formatDate(e,t){var r={Y:(e=ensureDate(e)).getFullYear(),M:e.getMonth()+1,D:e.getDate(),h:e.getHours(),m:e.getMinutes(),s:e.getSeconds()};return t.replace(/([YMDhms])\1*/g,(function(e){var t=r[e[0]].toString(),n=e.length;return n>t.length&&(t=new Array(n-t.length+1).join("0")+t),t}))}function formatSeconds(e,t){if(void 0===t&&(t={segments:2,digits:2}),e=Number(e),isNaN(e)||e<0)throw new Error('"secs" must be a positive integer');var r=0|(t.segments||2),n=0|(t.digits||2);n=Math.max(1,n),-1===[2,3].indexOf(r)&&(r=2);var o=new Array(n+1).join("0"),a=[60,1];return 3===t.segments&&a.unshift(3600),a.map((function(t){var r=Math.floor(e/t),a=r.toString().length;return e%=t,(o+r).slice(-Math.max(a,n))})).join(":")}Object.defineProperty(exports,"__esModule",{value:!0}),exports.formatSeconds=exports.formatDate=void 0,exports.formatDate=formatDate,exports.formatSeconds=formatSeconds;

package/dist/cjs/json.d.ts

@@ -0,0 +1,43 @@
+/**
+ * 本模块提供 json 处理相关方法。
+ * @packageDocumentation
+ */
+/**
+ * 深度克隆指定对象（仅限 JSON 支持的数据类型）。
+ * @param obj 指定对象。
+ * @return 克隆结果。
+ * @example
+ * ```javascript
+ * cloneJSON({ a: 1, b: 2 }); // { a: 1, b: 2 }
+ * ```
+ */
+export declare function cloneJSON(obj: unknown): any;
+/**
+ * JSON 字符串解析失败时的回调。
+ */
+export interface IErrorCallback {
+    (e: Error): unknown;
+}
+/**
+ * 尝试把指定字符串解析为 JSON 对象。
+ * @param str 指定字符串。
+ * @param onError 解析出错时执行的回调函数。函数返回值会作为解析失败时的解析结果。
+ * @return 解析结果。
+ * @example
+ * ```javascript
+ * tryParseJSON('ss&&**'); // undefined
+ * tryParseJSON('{"a": 1}'); // { a: 1 }
+ * ```
+ */
+export declare function tryParseJSON(str: string, onError?: IErrorCallback): unknown;
+/**
+ * 尝试把指定字符串解析为 JSON 对象。
+ * @param str 指定字符串。
+ * @param defaultValue 解析出错时的默认结果。
+ * @return 解析结果。
+ * @example
+ * ```javascript
+ * tryParseJSON('12&&**', 1); // 1
+ * ```
+ */
+export declare function tryParseJSON(str: string, defaultValue?: unknown): unknown;

package/dist/cjs/json.js

@@ -0,0 +1 @@
+"use strict";function cloneJSON(e){return null==e?e:JSON.parse(JSON.stringify(e))}function tryParseJSON(e,r){var t;try{t=JSON.parse(e)}catch(e){t="function"==typeof r?r(e):r}return t}Object.defineProperty(exports,"__esModule",{value:!0}),exports.tryParseJSON=exports.cloneJSON=void 0,exports.cloneJSON=cloneJSON,exports.tryParseJSON=tryParseJSON;

package/dist/cjs/net.d.ts

@@ -0,0 +1,32 @@
+/**
+ * 本模块提供网络协议相关方法。
+ * @packageDocumentation
+ */
+/**
+ * 检查目标字符串是否以特定 URL 协议开头。
+ * @param str 目标字符串。
+ * @param protocols 特定协议（不含冒号和斜杠），不指定时表示允许任何协议。
+ * @return 目标字符串是否以特定 URL 协议开头。
+ * @example
+ * ```javascript
+ * startsWithProtocol('//abc.com'); // true
+ * startsWithProtocol('https://abc.com'); // true
+ * startsWithProtocol('file:///Users/'); // true
+ * startsWithProtocol('abc.com'); // false
+ * startsWithProtocol('http://abc.com', ['http', 'https']); // true
+ * startsWithProtocol('ftp://abc.com', ['http', 'https']); // false
+ * ```
+ */
+export declare function startsWithProtocol(str: string, protocols?: string[]): boolean;
+/**
+ * 替换目标字符串中的 URL 协议。如果字符串中不包含协议，则加上协议。
+ * @param url 目标字符串。
+ * @param protocol 协议。
+ * @return 替换结果。
+ * @example
+ * ```javascript
+ * changeProtocol('abc.com', 'https'); // 'https://abc.com'
+ * changeProtocol('http://abc.com', 'https'); // 'https://abc.com'
+ * ```
+ */
+export declare function changeProtocol(url: string, protocol: string): string;

package/dist/cjs/net.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.changeProtocol=exports.startsWithProtocol=void 0;var reProtocol=/^(?:([a-z]+):)?\/{2,3}/i;function startsWithProtocol(o,t){var r=reProtocol.test(o);if(r&&t){for(var e=(RegExp.$1||"").toLowerCase(),c=t.length-1;c>=0;c--)if(e===t[c].toLowerCase())return!0;return!1}return r}function changeProtocol(o,t){return reProtocol.test(t)||(t+="://"),startsWithProtocol(o)?o.replace(reProtocol,t):t+o}exports.startsWithProtocol=startsWithProtocol,exports.changeProtocol=changeProtocol;

package/dist/cjs/string.d.ts

@@ -0,0 +1,94 @@
+/**
+ * 本模块提供字符串处理相关方法。
+ * @packageDocumentation
+ */
+/**
+ * 计算字符串长度的选项。
+ */
+export interface IStrLenOptions {
+    /**
+     * 英文字符单位长度。
+     */
+    enLen?: number;
+    /**
+     * 非英文字符单位长度。
+     */
+    nonEnLen?: number;
+}
+/**
+ * 裁剪字符串的选项。
+ */
+export interface ICutStrOptions extends IStrLenOptions {
+    /**
+     * 省略符，默认为三个点号。
+     */
+    ellipsis?: string;
+}
+/**
+ * 计算字符串长度。默认情况下，英文字符的单位长度为 1，非英文字符的单位长度为 2。
+ * @param str 字符串。
+ * @param options 为数字时表示非英文字符单位长度（此时英文字符单位长度为 1）；为 Object 时表示选项。
+ * @return 字符串长度。
+ * @example
+ * ```javascript
+ * strLen('abcde;'); // 6
+ * strLen('abc测试；'); // 9
+ * strLen('abc测试；', 1); // 6
+ * strLen('abc测试；', { enLen: 0.5, nonEnLen: 1 }); // 4.5
+ * ```
+ */
+export declare function strLen(str: string, options?: number | IStrLenOptions): number;
+/**
+ * 如果目标字符串超出限制长度，则进行截断并拼接省略符号；否则返回目标字符串。
+ * 默认情况下，英文字符的单位长度为 1，非英文字符的单位长度为 2。
+ * @param str 目标字符串。
+ * @param length 限制的长度。
+ * @param options 选项。
+ * @return 截断后的字符串。
+ * @example
+ * ```javascript
+ * cutStr('测试一下', 5); // '测试...'
+ * cutStr('测试一下', 8); // '测试一下'
+ * curStr('1测试2测试3', 3.5, { enLen: 0.5, nonEnLen: 1 }); // 1测...
+ * ```
+ */
+export declare function cutStr(str: string, length: number, options?: ICutStrOptions): string;
+/**
+ * 把指定字符串中的 HTML 预留字符替换成 HTML 实体。
+ * @param str 指定字符串。
+ * @return 替换后的字符串。
+ */
+export declare function escapeHTML(str: string): string;
+/**
+ * 移除指定字符串中的 HTML 标签。
+ * @param str 指定字符串。
+ * @return 处理后的字符串。
+ */
+export declare function removeTags(str: string): string;
+/**
+ * 把指定字符串中的换行符替换成 <br />。
+ * @param str 指定字符串。
+ * @return 替换后的字符串。
+ */
+export declare function nl2br(str: string): string;
+/**
+ * 生成随机字符串。
+ * @param length 字符串长度。
+ * @param prefix 字符串前缀（不计入长度）。
+ * @returns 生成的随机字符串。
+ */
+export declare function randomStr(length: number, prefix?: string): string;
+/**
+ * 生成 uuid(v4)。
+ * @returns uuid。
+ */
+export declare function uuidV4(): string;
+/**
+ * 版本号对比。
+ * @param versionA 待比较版本 A。
+ * @param versionB 待比较版本 B。
+ * @return 大于 0 时，表示版本 A 大于版本 B；
+ *   小于 0 时，表示版本 B 大于版本 A；
+ *   等于 0 时，表示两个版本号一致。
+ */
+export declare function compareVersions(verA: string, verB: string): number;

package/dist/cjs/string.js

@@ -0,0 +1 @@
+"use strict";function strLen(e,r){var n,t;"number"==typeof r?r={enLen:1,nonEnLen:r}:((r=r||{}).enLen=null!==(n=r.enLen)&&void 0!==n?n:1,r.nonEnLen=null!==(t=r.nonEnLen)&&void 0!==t?t:2);for(var o=0,s=e.length-1;s>=0;s--)o+=e.charCodeAt(s)>255?r.nonEnLen||0:r.enLen||0;return o}function cutStr(e,r,n){(n=n||{}).enLen=Number(n.enLen)||1,n.nonEnLen=Number(n.nonEnLen)||2,n.ellipsis=n.ellipsis||"...";var t=strLen(e=String(e),n);if(t<=r)return e;r-=strLen(n.ellipsis,n);for(var o="",s=-1;r>0&&++s<t;)(r-=e.charCodeAt(s)>255?n.nonEnLen:n.enLen)>=0&&(o+=e.charAt(s));return o+=n.ellipsis}function escapeHTML(e){if(null==e)return e;var r={'"':"&quot;","'":"&#39;","&":"&amp;","<":"&lt;",">":"&gt;"};return String(e).replace(/["'&<>]/g,(function(e){return r[e]}))}function removeTags(e){return null==e?"":String(e).replace(/<.+?>/g,"")}function nl2br(e){return null==e?e:String(e).replace(/\r?\n/g,"<br />")}function randomStr(e,r){if(!(e|=0)||e<0)throw new Error('"length" must be a number greater than 0');var n="";do{n+=Math.random().toString(36).substr(2)}while(n.length<e);return n=n.substr(0,e),null!=r&&(n=r+n),n}function uuidV4(){var e=Date.now();return"undefined"!=typeof performance&&"function"==typeof performance.now&&(e+=performance.now()),"xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx".replace(/[xy]/g,(function(r){var n=(e+16*Math.random())%16|0;return e=Math.floor(e/16),("x"===r?n:3&n|8).toString(16)}))}function compareVersions(e,r){if(!e||!r)throw new Error("Please specify both verA and verB");for(var n=/(\.0+)+$/,t=String(e).replace(n,"").split("."),o=String(r).replace(n,"").split("."),s=Math.min(t.length,o.length),a=0;a<s;a++){var u=parseInt(t[a])-parseInt(o[a]);if(u)return u}return t.length-o.length}Object.defineProperty(exports,"__esModule",{value:!0}),exports.compareVersions=exports.uuidV4=exports.randomStr=exports.nl2br=exports.removeTags=exports.escapeHTML=exports.cutStr=exports.strLen=void 0,exports.strLen=strLen,exports.cutStr=cutStr,exports.escapeHTML=escapeHTML,exports.removeTags=removeTags,exports.nl2br=nl2br,exports.randomStr=randomStr,exports.uuidV4=uuidV4,exports.compareVersions=compareVersions;

package/dist/cjs/validate.d.ts

@@ -0,0 +1,26 @@
+/**
+ * 本模块提供数据验证方法。
+ * @packageDocumentation
+ */
+/**
+ * 检查目标字符串是否中国大陆手机号。
+ * @param str 目标字符串。
+ * @return 目标字符串是否中国大陆手机号。
+ * @example
+ * ```javascript
+ * isChsPhoneNO('13800138000'); // true
+ * isChsPhoneNO('a13800138000c'); // false
+ * ```
+ */
+export declare function isChsPhoneNO(str: string): boolean;
+/**
+ * 检查目标字符串是否电子邮箱地址。
+ * @param str 目标字符串。
+ * @return 目标字符串是否电子邮箱地址。
+ * @example
+ * ```javascript
+ * isEmail('me@polyv.net'); // true
+ * isEmail('me@polyv_.net-'); // false
+ * ```
+ */
+export declare function isEmail(str: string): boolean;

package/dist/cjs/validate.js

@@ -0,0 +1 @@
+"use strict";function isChsPhoneNO(e){return/^1[3-9]\d{9}$/.test(e)}function isEmail(e){if(/^[\w-]+(?:\.[\w-]+)*@[\w-]+(?:\.[\w-]+)*\.[a-zA-Z]{2,}$/.test(e)){for(var s=e.replace("@",".").split("."),t=s.length-1;t>=0;t--)if(/^[-_]/.test(s[t])||/[_-]$/.test(s[t]))return!1;return!0}return!1}Object.defineProperty(exports,"__esModule",{value:!0}),exports.isEmail=exports.isChsPhoneNO=void 0,exports.isChsPhoneNO=isChsPhoneNO,exports.isEmail=isEmail;

package/dist/es/boolean.d.ts

@@ -0,0 +1,45 @@
+/**
+ * 本模块提供布尔值处理相关方法。
+ * @packageDocumentation
+ */
+/**
+ * Y 或者 N。
+ */
+export declare type YOrN = 'Y' | 'N';
+/**
+ * 布尔值转换为 Y 或者 N。
+ * @param value 布尔值。
+ * @return Y 或者 N。
+ */
+export declare function boolToYN(value: boolean): YOrN;
+/**
+ * Y 或者 N 转换为布尔值。
+ * @param value Y 或者 N。
+ * @param defaultValue 当 value 为非法值时的默认值。
+ * @return 布尔值。
+ */
+export declare function ynToBool(value: YOrN, defaultValue?: YOrN): boolean;
+/**
+ * 检查指定数组元素的值是否都为 Y。
+ * @param values 指定数组。
+ * @return 指定数组元素的值是否都为 Y。
+ */
+export declare function allY(values: YOrN[]): boolean;
+/**
+ * 检查指定数组元素的值是否至少有一个为 Y。
+ * @param values 指定数组。
+ * @return 指定数组元素的值是否至少有一个为 Y。
+ */
+export declare function someY(values: YOrN[]): boolean;
+/**
+ * 检查指定数组元素的值是否都为 N。
+ * @param values 指定数组。
+ * @return 指定数组元素的值是否都为 N。
+ */
+export declare function allN(values: YOrN[]): boolean;
+/**
+ * 检查指定数组元素的值是否至少有一个为 N。
+ * @param values 指定数组。
+ * @return 指定数组元素的值是否至少有一个为 N。
+ */
+export declare function someN(values: YOrN[]): boolean;

package/dist/es/boolean.js

@@ -0,0 +1 @@
+export function boolToYN(o){if("boolean"!=typeof o)throw new Error("The value argument must be a boolean type");return o?"Y":"N"}export function ynToBool(o,n){let e=String(o).toUpperCase();if("Y"!==e&&"N"!==e){if(null==n)throw new Error('The value argument must be "Y" or "N"');e=String(n).toUpperCase()}return"Y"===e}export function allY(o){return o.every((function(o){return ynToBool(o)}))}export function someY(o){return o.some((function(o){return ynToBool(o)}))}export function allN(o){return o.every((function(o){return!ynToBool(o)}))}export function someN(o){return o.some((function(o){return!ynToBool(o)}))}

package/dist/es/countdown.d.ts

@@ -0,0 +1,97 @@
+/**
+ * 本模块提供倒计时功能。
+ * @packageDocumentation
+ */
+/**
+ * 表示剩余时长。
+ */
+export interface IRemaining {
+    /**
+     * 剩余天数。
+     */
+    days: number;
+    /**
+     * 剩余小时数。
+     */
+    hours: number;
+    /**
+     * 剩余分钟数。
+     */
+    minutes: number;
+    /**
+     * 剩余秒数。
+     */
+    seconds: number;
+    /**
+     * 剩余总时间的毫秒表示。
+     */
+    totalMsecs: number;
+}
+/**
+ * 倒计时的回调函数。
+ */
+export interface ICountdownCallback {
+    (remaining: IRemaining): void;
+}
+/**
+ * 倒计时类。
+ * @example
+ * ```javascript
+ * const countdown = new Countdown(60, (remaining) => {
+ *   console.dir(remaining);
+ * });
+ * countdown.start();
+ * ```
+ */
+export declare class Countdown {
+    /**
+     * 倒计时总时间的毫秒表示。
+     */
+    protected readonly _totalMSecs: number;
+    /**
+     * 倒计时回调函数。
+     */
+    protected readonly _cb: ICountdownCallback;
+    /**
+     * 倒计时剩余时间的毫秒表示。
+     */
+    protected _remainingMSecs?: number;
+    /**
+     * 当前正在使用的倒计时秒数。
+     */
+    protected _usingMSecs?: number;
+    /**
+     * 倒计时开始时间的毫秒级时间戳，为 undefined 时表示倒计时未开始。
+     */
+    protected _startTime?: number;
+    /**
+     * 倒计时定时器 id。
+     */
+    protected _timerId?: number;
+    /**
+     * 倒计时类构造函数。
+     * @param secs 倒计时总秒数。
+     * @param cb 剩余时长的回调函数，正常情况下大概 1 秒回调一次。
+     */
+    constructor(totalSecs: number, cb: ICountdownCallback);
+    /**
+     * 倒计时的具体操作。
+     */
+    protected _exec(): void;
+    /**
+     * 开始倒计时。
+     */
+    start(): void;
+    /**
+     * 中断倒计时。
+     */
+    protected _break(): void;
+    /**
+     * 停止倒计时。如果再次调用 start，则重新开始倒计时。
+     */
+    stop(): void;
+    /**
+     * 暂停倒计时。如果再次调用 start，则继续未完成的倒计时。
+     */
+    pause(): void;
+}

package/dist/es/countdown.js

@@ -0,0 +1 @@
+const computes=[{divisor:86400,unit:"days"},{divisor:3600,unit:"hours"},{divisor:60,unit:"minutes"},{divisor:1,unit:"seconds"}];export class Countdown{constructor(s,t){if(s|=0,isNaN(s))throw new Error("Total seconds must be a number");this._totalMSecs=1e3*s,this._cb=t}_exec(){if(!this._startTime||null==this._usingMSecs)return;let s=Math.max(0,this._usingMSecs-(Date.now()-this._startTime));if(s>0&&setTimeout((()=>{this._exec()}),1e3),this._remainingMSecs=s,s>=0){const t={days:0,hours:0,minutes:0,seconds:0,totalMsecs:s};s=Math.round(s/1e3),computes.forEach(((i,e)=>{t[i.unit]=s/i.divisor,e===computes.length-1?t[i.unit]=Math.round(t[i.unit]):(t[i.unit]=Math.floor(t[i.unit]),s%=i.divisor)})),this._cb(t)}}start(){null==this._usingMSecs&&(this._usingMSecs=this._totalMSecs),this._usingMSecs<=0||(this._startTime=Date.now(),this._exec())}_break(){this._timerId&&clearTimeout(this._timerId),this._startTime=void 0}stop(){this._break(),this._usingMSecs=this._totalMSecs}pause(){this._break(),this._usingMSecs=this._remainingMSecs}}