介绍
envalid 是一个用于验证和解析环境变量的 npm 包。它可以帮助开发者快速地读取和验证环境变量，同时提高代码的可读性和可维护性。
安装
在终端中运行以下命令即可安装 envalid。
npm install envalid --save
使用
引入模块
在需要使用 envalid 的文件中，引入模块并定义需要读取的环境变量及其规则。
const { str, num, bool, url } = require('envalid');
const env = envalid.cleanEnv(process.env, {
API_KEY: str(),
PORT: num({ default: 3000 }),
DEBUG: bool({ default: false }),
API_URL: url({ default: 'https://api.example.com' })
});定义规则
在上面的代码中，str()、num()、bool() 和 url() 都是 envalid 提供的规则函数。它们可以验证环境变量的值是否符合预期。如果不符合预期，envalid 会抛出错误信息。
除了定义规则，也可以为环境变量设置默认值。如果环境变量没有被定义或者值无效，envalid 将使用默认值作为环境变量的值。在上面的代码中，PORT 和 DEBUG 都设置了默认值。
获取环境变量
通过 envalid.cleanEnv() 函数获取的 env 对象包含了已验证并解析好的环境变量。我们可以直接访问其属性来获取环境变量的值。
const apiKey = env.API_KEY; const port = env.PORT; const debug = env.DEBUG; const apiUrl = env.API_URL;
示例代码
下面是一个完整的示例代码，包括了定义规则和读取环境变量。
-- -------------------- ---- ------- ----- - ---- ---- ----- --- - - ------------------- ----- --- - ----------------------------- - -------- ------ ----- ----- -------- ---- --- ------ ------ -------- ----- --- -------- ----- -------- ------------------------- -- --- ----- ------ - ------------ ----- ---- - --------- ----- ----- - ---------- ----- ------ - ------------ -------------------- ------------------ ------------------- --------------------
总结
envalid 是一个非常实用的 npm 包，可以帮助我们快速地读取和验证环境变量。在开发过程中，我们可以根据需求定义环境变量的规则，并使用默认值来提高代码的可读性和可维护性。如果您正在开发前端应用程序，建议使用 envalid 来读取和验证环境变量。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/5f6aba47a9b7065299ccb88d