什么是dotenv-to-ts
dotenv-to-ts 是一个 npm 包，它将 dotenv 文件（.env 或 .env.production 等）中的环境变量定义转换为 TypeScript 类型定义。这样做可以避免手动维护环境变量和 TypeScript 类型定义的时候出现的错误。dotenv-to-ts 支持自动生成已有的环境变量的 TypeScript 类型定义，因此我们可以直接在实际编程中使用它来生成类型安全的代码。
dotenv-to-ts 的使用方法
安装
使用 npm 安装
使用 npm 命令行工具安装 dotenv-to-ts:
npm install dotenv-to-ts --save-dev
配置
创建 .env 文件
dotenv-to-ts 从 .env 文件中获取环境变量。创建一个 .env 文件:
PORT=3000 DATABASE_URL=mongodb://localhost:27017/mydatabase
创建 TypeScript 文件
创建一个 TypeScript 文件，例如 config.ts，用来存储生成的 TypeScript 类型定义。dotenv-to-ts 将根据 .env 文件中的变量自动生成相应的 TypeScript 定义。
// config.ts
import type { Env } from 'dotenv-to-ts';
export const env: Env = process.env;运行 dotenv-to-ts
在运行 dotenv-to-ts 之前，需要先在 package.json 文件中定义一个命令来运行命令行式的 dotenv-to-ts。
{
"scripts": {
"generate-types": "dotenv-to-ts --path .env --outDir src/types"
}
}在第一个参数 --path 中定义了要读取的 .env 文件路径。在第二个参数 --outDir 中定义了生成的 TypeScript 文件的输出目录。
在命令行中运行：
npm run generate-types
这将生成一个名为 env.d.ts 文件，包含如下的 TypeScript 类型定义：
interface Env {
PORT: string;
DATABASE_URL: string;
}使用生成的 TypeScript 文件
现在我们可以在我们的代码中使用生成的类型定义。例如，我们的应用程序需要使用环境变量设置数据库 URL。假设我们使用了 MongoDB 数据库。我们需要连接到一个名为 mydatabase 的数据库。
-- -------------------- ---- ------- -- ------ ------ - ----------- - ---- ---------- ------ - --- - ---- ----------- ----- --- - ----------------- ------------------------ ----- ------- -- - -- ---- ---
这些代码现在是类型安全的了。
总结
dotenv-to-ts 是一个非常有用的 npm 包，它可以自动为我们生成 TypeScript 类型定义。通过使用 dotenv-to-ts，我们可以确保在定义环境变量时不会犯错，并且我们可以直接在我们的代码中使用类型安全的环境变量。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005662e81e8991b448e20da