@anjianshi/utils 2.1.4 → 2.1.6

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

@@ -1,3 +1,9 @@
+type EnvValue = string | number | boolean | unknown[] | Record<string, unknown>;
+type TypeDef = 'string' | 'number' | 'boolean' | unknown[] | Record<string, unknown>;
+type TypeFrom<D extends TypeDef> = D extends 'string' ? string : D extends 'number' ? number : D extends 'boolean' ? boolean : D;
+type ResultFrom<Defs extends Record<string, TypeDef>> = {
+    [K in keyof Defs]: TypeFrom<Defs[K]>;
+};
 /**
  * 读取 .env 文件，并获取格式化后的数据
  * 注意：依赖 dotenv 包
@@ -20,8 +26,27 @@ export declare class EnvReader {
      * 获取指定 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;
+    getByType(key: string, type?: 'string'): string | undefined;
+    getByType(key: string, type: 'number'): number | undefined;
+    getByType(key: string, type: 'boolean'): boolean | undefined;
+    getByType<T extends unknown[] | Record<string, unknown>>(key: string, type: 'json'): T | undefined;
+    /**
+     * 同 envReader.get()，只不过是通过对象指定各 env 的默认值来批量获取
+     * envReader.batchGet({ port: 8000, debug: false, mobiles: ['123', '456'] }
+     */
+    batchGet<Defs extends Record<string, EnvValue>>(definitions: Defs): Defs;
+    /**
+     * 同 envReader.getByType()，只不过是通过对象指定各 env 的类型来批量获取。
+     * 若 required 为 true，要求所有 env 都必须有值，否则会抛出异常；默认为 false。
+     *
+     * envReader.batchGetByType({
+     *   port: 'number',
+     *   debug: 'boolean',
+     *   mobiles: [] as string[],  // 用此格式定义内容是数组的 JSON 值
+     *   obj: {} as { a: number, b: string } // 用此格式定义内容是对象的 JSON 值
+     * })
+     */
+    batchGetByType<Defs extends Record<string, TypeDef>>(definitions: Defs, required?: false): Partial<ResultFrom<Defs>>;
+    batchGetByType<Defs extends Record<string, TypeDef>>(definitions: Defs, required: true): ResultFrom<Defs>;
 }
+export {};

package/env-node/env-reader.js

@@ -52,4 +52,25 @@ export class EnvReader {
             return safeParseJSON(raw);
         return raw;
     }
+    /**
+     * 同 envReader.get()，只不过是通过对象指定各 env 的默认值来批量获取
+     * envReader.batchGet({ port: 8000, debug: false, mobiles: ['123', '456'] }
+     */
+    batchGet(definitions) {
+        const result = {};
+        for (const [key, defaults] of Object.entries(definitions)) {
+            result[key] = this.get(key, defaults);
+        }
+        return result;
+    }
+    batchGetByType(definitions, required = false) {
+        const result = {};
+        for (const [key, def] of Object.entries(definitions)) {
+            const value = typeof def === 'string' ? this.getByType(key, def) : this.getByType(key, 'json');
+            if (value === undefined && required)
+                throw new Error(`env ${key} needs a value`);
+            result[key] = value;
+        }
+        return result;
+    }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@anjianshi/utils",
-  "version": "2.1.4",
+  "version": "2.1.6",
   "description": "Common JavaScript Utils",
   "homepage": "https://github.com/anjianshi/js-packages/utils",
   "bugs": {
@@ -27,9 +27,9 @@
     "vconsole": "^3.15.1",
     "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-prettier": "3.0.0"
+    "@anjianshi/presets-eslint-node": "4.0.4"
   },
   "peerDependencies": {
     "chalk": "^5.3.0",