ph-utils 0.4.5 → 0.4.7

package/lib/date.d.ts

@@ -1,15 +1,15 @@
 /**
  * 将日期格式化为指定形式的字符串
  * @param date      日期
- * @param pattern   格式化字符串 yyyy - 年, mm - 月, dd - 日, HH - 小时, MM - 分钟, ss - 秒
+ * @param pattern   格式化字符串 yyyy - 年, mm - 月, dd - 日, HH - 小时, MM - 分钟, ss - 秒, S - 毫秒, 默认: yyyy-mm-dd HH:MM:ss
  */
-export declare function format(date?: Date | string | number, pattern?: string): string;
+export declare function format(date?: Date | string | number | null, pattern?: string): string;
 /**
  * 将指定的参数解析为日期对象(Date)
  * 参考 dayjs 实现, 也可以参考 https://github.com/nomiddlename/date-format
  * @param date 待解析的日期参数
  */
-export declare function parse(date?: Date | string | number): Date;
+export declare function parse(date?: Date | string | number | null): Date;
 /**
  * 设置日期的开始或者结束的点
  * @param {Object} date 日期，能够被 parse 解析的日期

package/lib/date.js

@@ -2,7 +2,7 @@
  * node 和 web 端日期处理工具类
  */
 // 配置日期格式的正则表达式
-const REGEX_FORMAT = /yy(?:yy)?|([HMmds])\1?/g;
+const REGEX_FORMAT = /yy(?:yy)?|([HMmds])\1?|(S)?/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 = {
@@ -72,9 +72,9 @@ function getLastDayOfYear(date, month) {
 /**
  * 将日期格式化为指定形式的字符串
  * @param date      日期
- * @param pattern   格式化字符串 yyyy - 年, mm - 月, dd - 日, HH - 小时, MM - 分钟, ss - 秒
+ * @param pattern   格式化字符串 yyyy - 年, mm - 月, dd - 日, HH - 小时, MM - 分钟, ss - 秒, S - 毫秒, 默认: yyyy-mm-dd HH:MM:ss
  */
-export function format(date, pattern = "yyyy-mm-dd HH:MM") {
+export function format(date, pattern = "yyyy-mm-dd HH:MM:ss") {
     // eslint-disable-next-line
     date = parse(date);
     const d = date.getDate();
@@ -96,6 +96,7 @@ export function format(date, pattern = "yyyy-mm-dd HH:MM") {
         MM: p(M),
         s: s,
         ss: p(s),
+        S: p(date.getMilliseconds(), 3),
     };
     if (pattern != null) {
         return pattern.replace(REGEX_FORMAT, (flag) => {

package/lib/file.js

@@ -1,6 +1,6 @@
 /** nodejs 文件操作工具类 */
-import path from 'node:path';
-import fs from 'node:fs';
+import path from "node:path";
+import fs from "node:fs";
 /**
  * 读取文件内容为JSON格式
  * @param filepath 读取的文件路径
@@ -8,7 +8,7 @@ import fs from 'node:fs';
  */
 export function readJSON(filepath) {
     return new Promise((resolve, reject) => {
-        fs.readFile(path.resolve(filepath), 'utf-8', (err, data) => {
+        fs.readFile(path.resolve(filepath), "utf-8", (err, data) => {
             if (err) {
                 reject(err);
             }
@@ -29,8 +29,8 @@ export function readJSON(filepath) {
 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') {
+        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) => {
@@ -55,21 +55,21 @@ export function traverseDir(dir, callback, done) {
         fs.readdir(path.resolve(dr), { withFileTypes: true }, (err, files) => {
             if (err && err.errno === -4052) {
                 // 本身就是文件
-                if (typeof cb === 'function')
+                if (typeof cb === "function")
                     cb(dr);
-                if (typeof d === 'function')
+                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')
+                        if (typeof cb === "function")
                             cb(path.join(dr, file.name));
                         clearTimeout(t);
                         t = setTimeout(() => {
                             setImmediate(() => {
-                                if (typeof done === 'function') {
+                                if (typeof done === "function") {
                                     done();
                                 }
                             });

package/lib/index.d.ts

@@ -50,6 +50,13 @@ interface RandomConfig {
  *  1. 生成指定长度的随机数
  *  2. 生成介于 [min, max] 之间的随机数
  * @param opts 生成随机数的配置
+ *
+ * @example <caption>1. 生成指定长度的随机字符串</caption>
+ * random(1); // 长度为 1 的随机字符串
+ *
+ * @example <caption>2. 生成纯数字且不能为0长度为1的随机字符</caption>
+ * random({ length: 1, hasLetter: false, firstIsZero: false })
+ *
  * @returns
  */
 export declare function random(opts: number | RandomConfig): string | number;

package/lib/index.js

@@ -40,7 +40,7 @@ export function shieldMobile(mobile) {
  * @returns true 是数字, false 不是数字
  */
 export function isNumeric(str, numericParam) {
-    numericParam = { isPositive: false, isFloat: true, ...(numericParam || {}) };
+    numericParam = { isPositive: false, isFloat: true, ...numericParam };
     const symbol = numericParam.isPositive ? "[+]?" : "[+-]?";
     const main = numericParam.isFloat ? "([0-9]*[.])?[0-9]+" : "[0-9]+";
     return new RegExp("^" + symbol + main + "$").test(str);
@@ -58,6 +58,13 @@ export function isBoolean(str) {
  *  1. 生成指定长度的随机数
  *  2. 生成介于 [min, max] 之间的随机数
  * @param opts 生成随机数的配置
+ *
+ * @example <caption>1. 生成指定长度的随机字符串</caption>
+ * random(1); // 长度为 1 的随机字符串
+ *
+ * @example <caption>2. 生成纯数字且不能为0长度为1的随机字符</caption>
+ * random({ length: 1, hasLetter: false, firstIsZero: false })
+ *
  * @returns
  */
 export function random(opts) {
@@ -74,12 +81,11 @@ export function random(opts) {
         }
         const len = typeof opts === "object" ? opts.length : opts;
         /* 生成指定长度的随机数 */
-        const charLens = RANDOM_CHARS.length;
         let chars = RANDOM_CHARS;
         if (typeof opts === "object" && opts.hasLetter === false) {
             chars = NUMBER_RANDOM_CHARTS;
         }
-        const resRandom = Array.from({ length: len }, () => chars.charAt(Math.floor(Math.random() * charLens))).join("");
+        const resRandom = Array.from({ length: len }, () => chars.charAt(random({ min: 0, max: 9, hasEnd: true }))).join("");
         if (typeof opts === "object" &&
             opts.firstIsZero === false &&
             resRandom.indexOf("0") === 0) {

package/package.json

@@ -52,7 +52,7 @@
     },
     "./*": "./lib/*"
   },
-  "version": "0.4.5",
+  "version": "0.4.7",
   "type": "module",
   "repository": {
     "type": "git",