@hz-9/a5-core 0.2.0-alpha.53 → 0.2.0-alpha.54

package/dist/all.d.ts

@@ -7,6 +7,7 @@ import { Logger } from '@nestjs/common';
 import { LoggerService } from '@nestjs/common/services/logger.service';
 import { LoggerService as LoggerService_2 } from '@nestjs/common';
 import { LogLevel } from '@nestjs/common/services/logger.service';
+import ms from 'ms';
 import { NestFactoryStatic } from '@nestjs/core/nest-factory';
 import { NestFastifyApplication } from '@nestjs/platform-fastify';
 import { NestMiddleware } from '@nestjs/common';
@@ -796,6 +797,54 @@ export declare const MODULE_CONFIG_PATH_A5_CONFIG: <T extends string>(str: T) =>
  */
 export declare const MODULE_CONFIG_PATH_A5_LOG: <T extends string>(str: T) => `A5.log.${T}`;
 
+/**
+ * @public
+ */
+export declare type MSStringValue = ms.StringValue;
+
+/**
+ * @public
+ */
+export declare class MSUtil {
+    /**
+     * 将 ms 时间字符串转换为毫秒数
+     *
+     * @param value - ms 时间字符串
+     * @returns 毫秒数
+     *
+     * @example
+     * ```typescript
+     * MSUtil.ms('123') // 123
+     * MSUtil.ms('2h') // 7200000
+     * MSUtil.ms('30s') // 30000
+     * MSUtil.ms('123 ms') // 123
+     * ```
+     */
+    static ms(value: ms.StringValue): number;
+    /**
+     * 判断字符串是否是有效的 ms 时间字符串格式
+     * 可以作为类型守卫使用，在运行时验证并断言为 ms.StringValue 类型
+     *
+     * @param value - 要检查的字符串值
+     * @returns 如果是有效的 ms 字符串返回 true，否则返回 false
+     *
+     * @example
+     * ```typescript
+     * // 有效格式
+     * MSUtil.isMsStringValue('123') // true
+     * MSUtil.isMsStringValue('2h') // true
+     * MSUtil.isMsStringValue('30s') // true
+     * MSUtil.isMsStringValue('123 ms') // true
+     *
+     * // 无效格式
+     * MSUtil.isMsStringValue('abc') // false
+     * MSUtil.isMsStringValue('') // false
+     * MSUtil.isMsStringValue('123xx') // false
+     * ```
+     */
+    static isMsStringValue(value: string): value is ms.StringValue;
+}
+
 /**
  * 类型断言工具 - 判断不是 any 类型
  *

package/dist/util/index.d.ts

@@ -2,5 +2,6 @@ export * from './a5.util';
 export * from './color.util';
 export * from './load-package.util';
 export * from './logo.util';
+export * from './ms.util';
 export * from './random.util';
 export * from './run-env.util';

package/dist/util/index.js

@@ -18,6 +18,7 @@ __exportStar(require("./a5.util"), exports);
 __exportStar(require("./color.util"), exports);
 __exportStar(require("./load-package.util"), exports);
 __exportStar(require("./logo.util"), exports);
+__exportStar(require("./ms.util"), exports);
 __exportStar(require("./random.util"), exports);
 __exportStar(require("./run-env.util"), exports);
 //# sourceMappingURL=index.js.map

package/dist/util/ms.util.d.ts

@@ -0,0 +1,47 @@
+import ms from 'ms';
+/**
+ * @public
+ */
+export type MSStringValue = ms.StringValue;
+/**
+ * @public
+ */
+export declare class MSUtil {
+    /**
+     * 将 ms 时间字符串转换为毫秒数
+     *
+     * @param value - ms 时间字符串
+     * @returns 毫秒数
+     *
+     * @example
+     * ```typescript
+     * MSUtil.ms('123') // 123
+     * MSUtil.ms('2h') // 7200000
+     * MSUtil.ms('30s') // 30000
+     * MSUtil.ms('123 ms') // 123
+     * ```
+     */
+    static ms(value: ms.StringValue): number;
+    /**
+     * 判断字符串是否是有效的 ms 时间字符串格式
+     * 可以作为类型守卫使用，在运行时验证并断言为 ms.StringValue 类型
+     *
+     * @param value - 要检查的字符串值
+     * @returns 如果是有效的 ms 字符串返回 true，否则返回 false
+     *
+     * @example
+     * ```typescript
+     * // 有效格式
+     * MSUtil.isMsStringValue('123') // true
+     * MSUtil.isMsStringValue('2h') // true
+     * MSUtil.isMsStringValue('30s') // true
+     * MSUtil.isMsStringValue('123 ms') // true
+     *
+     * // 无效格式
+     * MSUtil.isMsStringValue('abc') // false
+     * MSUtil.isMsStringValue('') // false
+     * MSUtil.isMsStringValue('123xx') // false
+     * ```
+     */
+    static isMsStringValue(value: string): value is ms.StringValue;
+}

package/dist/util/ms.util.js

@@ -0,0 +1,66 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MSUtil = void 0;
+const ms_1 = __importDefault(require("ms"));
+/**
+ * @public
+ */
+class MSUtil {
+    /**
+     * 将 ms 时间字符串转换为毫秒数
+     *
+     * @param value - ms 时间字符串
+     * @returns 毫秒数
+     *
+     * @example
+     * ```typescript
+     * MSUtil.ms('123') // 123
+     * MSUtil.ms('2h') // 7200000
+     * MSUtil.ms('30s') // 30000
+     * MSUtil.ms('123 ms') // 123
+     * ```
+     */
+    static ms(value) {
+        return (0, ms_1.default)(value);
+    }
+    /**
+     * 判断字符串是否是有效的 ms 时间字符串格式
+     * 可以作为类型守卫使用，在运行时验证并断言为 ms.StringValue 类型
+     *
+     * @param value - 要检查的字符串值
+     * @returns 如果是有效的 ms 字符串返回 true，否则返回 false
+     *
+     * @example
+     * ```typescript
+     * // 有效格式
+     * MSUtil.isMsStringValue('123') // true
+     * MSUtil.isMsStringValue('2h') // true
+     * MSUtil.isMsStringValue('30s') // true
+     * MSUtil.isMsStringValue('123 ms') // true
+     *
+     * // 无效格式
+     * MSUtil.isMsStringValue('abc') // false
+     * MSUtil.isMsStringValue('') // false
+     * MSUtil.isMsStringValue('123xx') // false
+     * ```
+     */
+    static isMsStringValue(value) {
+        if (typeof value !== 'string' || value.length === 0) {
+            return false;
+        }
+        try {
+            // 尝试转换，如果 ms() 函数能成功解析则说明格式正确
+            // 使用类型断言因为我们正在验证这个值
+            const result = (0, ms_1.default)(value);
+            return typeof result === 'number' && Number.isNaN(result) === false;
+        }
+        catch (error) {
+            return false;
+        }
+    }
+}
+exports.MSUtil = MSUtil;
+//# sourceMappingURL=ms.util.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hz-9/a5-core",
-  "version": "0.2.0-alpha.53",
+  "version": "0.2.0-alpha.54",
   "description": "The core library for the `@hz-9/a5-*` series of repositories.",
   "keywords": [
     "nest",
@@ -53,7 +53,9 @@
     "type-fest": "~4.20.0",
     "upath": "~2.0.1",
     "ua-parser-js": "~1.0.38",
-    "uuid": "^10.0.0"
+    "uuid": "^10.0.0",
+    "ms": "~2.1.3",
+    "@types/ms": "~2.1.0"
   },
   "devDependencies": {
     "@hz-9/eslint-config-airbnb-ts": "~0.6.0",