@anjianshi/utils 2.1.2 → 2.1.4

package/env-node/env-reader.d.ts

@@ -3,10 +3,25 @@
  * 注意：依赖 dotenv 包
  */
 export declare class EnvReader {
-    readonly envFiles: string | string[];
-    envsFromFile: Record<string, string>;
-    constructor(envFiles: string | string[]);
+    protected loadedEnvs: Record<string, string>;
+    constructor(envFiles?: string | string[]);
+    protected toNumber(raw: string): number | undefined;
+    protected toBoolean(raw: string): boolean | undefined;
+    getRaw(key: string): string | undefined;
+    /**
+     * 获取指定 env 的值，并转换成与 defaults 匹配的类型。
+     * 若值不存在，返回 defaults。
+     */
     get(key: string, defaults: string): string;
     get(key: string, defaults: number): number;
     get(key: string, defaults: boolean): boolean;
+    get<T extends unknown[] | Record<string, unknown>>(key: string, defaults: T): T;
+    /**
+     * 获取指定 env 的值，并转换成指定类型，无需提供默认值。
+     * 值不存在或转换失败时，返回 undefined。
+     */
+    getByType(key: string, type?: 'string'): string;
+    getByType(key: string, type: 'number'): number;
+    getByType(key: string, type: 'boolean'): boolean;
+    getByType<T extends unknown[] | Record<string, unknown>>(key: string, type: 'json'): T;
 }

package/env-node/env-reader.js

@@ -1,31 +1,55 @@
 import * as dotenv from 'dotenv';
+import { safeParseJSON } from '../lang/string.js';
 /**
  * 读取 .env 文件，并获取格式化后的数据
  * 注意：依赖 dotenv 包
  */
 export class EnvReader {
-    envFiles;
-    envsFromFile = {};
+    loadedEnvs = {};
     constructor(envFiles) {
-        this.envFiles = envFiles;
         dotenv.config({
-            path: this.envFiles,
-            processEnv: this.envsFromFile, // 把从 .env 文件读到的内容写入到此实例的属性，而不是 process.env
+            path: envFiles,
+            processEnv: this.loadedEnvs, // 把从 .env 文件读到的内容写入此变量，而不是 process.env，以避免污染 process.env。
         });
     }
+    toNumber(raw) {
+        const num = parseInt(raw, 10);
+        return isFinite(num) ? num : undefined;
+    }
+    toBoolean(raw) {
+        const formatted = raw.toLowerCase().trim();
+        if (['1', 'true', 'on'].includes(formatted))
+            return true;
+        if (['0', 'false', 'off'].includes(formatted))
+            return false;
+        return undefined;
+    }
+    getRaw(key) {
+        return this.loadedEnvs[key] ?? process.env[key];
+    }
     get(key, defaults) {
-        const value = this.envsFromFile[key] ?? process.env[key];
-        if (value === undefined)
+        const raw = this.getRaw(key);
+        if (raw === undefined)
             return defaults;
-        if (typeof defaults === 'number') {
-            const numValue = parseInt(value, 10);
-            return isFinite(numValue) ? numValue : defaults;
-        }
-        else if (typeof defaults === 'boolean') {
-            return ['1', 'true'].includes(value.toLowerCase().trim());
-        }
-        else {
-            return value;
+        if (typeof defaults === 'number')
+            return this.toNumber(raw) ?? defaults;
+        else if (typeof defaults === 'boolean')
+            return this.toBoolean(raw) ?? defaults;
+        else if (Array.isArray(defaults) || typeof defaults === 'object') {
+            return safeParseJSON(raw) ?? defaults;
         }
+        return raw;
+    }
+    getByType(key, type = 'string') {
+        const raw = this.getRaw(key);
+        if (raw === undefined)
+            return raw;
+        if (type === 'number')
+            return this.toNumber(raw);
+        if (type === 'boolean')
+            return this.toBoolean(raw);
+        if (type === 'json')
+            return safeParseJSON(raw);
+        return raw;
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@anjianshi/utils",
-  "version": "2.1.2",
+  "version": "2.1.4",
   "description": "Common JavaScript Utils",
   "homepage": "https://github.com/anjianshi/js-packages/utils",
   "bugs": {
@@ -28,8 +28,8 @@
     "typescript": "^5.4.4",
     "@anjianshi/presets-eslint-typescript": "4.0.4",
     "@anjianshi/presets-eslint-node": "4.0.4",
-    "@anjianshi/presets-prettier": "3.0.0",
-    "@anjianshi/presets-typescript": "3.1.4"
+    "@anjianshi/presets-typescript": "3.1.4",
+    "@anjianshi/presets-prettier": "3.0.0"
   },
   "peerDependencies": {
     "chalk": "^5.3.0",