简介
dotenv-safe 是一个可用于 Node.js 的 npm 包,用于从 .env
文件中加载环境变量,并确保必需的环境变量已设置。它是 dotenv 的增强版,能够提供更加安全的方式来设置环境变量。
安装
使用 npm 或 yarn 进行安装:
npm install dotenv-safe # 或 yarn add dotenv-safe
使用
- 创建
.env
文件,将需要的环境变量键值对写入其中。例如:
DB_HOST=localhost DB_USER=root DB_PASSWORD=123456
- 在 Node.js 应用程序中引入
dotenv-safe
包,并使用config
方法加载环境变量。例如:
const dotenv = require('dotenv-safe'); const result = dotenv.config(); if (result.error) { throw result.error; } console.log(result.parsed);
- 环境变量已成功加载并存储在
result.parsed
对象中,可以像使用普通的环境变量一样使用它们。例如:
-- -------------------- ---- ------- ----- ----- - ----------------- ----- ---------- - ------------------------ ----- -------------------- ----- -------------------- --------- ----------------------- --- ---------------------
- 如果某个必需的环境变量未设置,程序将抛出一个错误。例如:
const result = dotenv.config({ example: '.env.example' }); if (result.error) { throw result.error; } const requiredEnvVars = ['DB_HOST', 'DB_USER', 'DB_PASSWORD']; dotenv.check(requiredEnvVars);
在上面的示例中,通过传递 example
选项,可以指定 .env.example
文件的路径来创建默认值。然后,使用 check()
方法检查必需环境变量是否已设置。
总结
使用 dotenv-safe 包可以轻松加载和管理 Node.js 应用程序的环境变量,并确保必需的环境变量已设置。此外,还可以提供默认值和自定义错误消息等功能,使代码更加安全和易于维护。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/46207