在前端开发中,环境变量的管理是非常重要的一个任务。envigor 是一个能够让我们更方便地管理环境变量的 npm 包,它支持从 .env
文件和命令行参数中读取变量,并可以将读取到的变量注入到 Node.js 的全局变量和浏览器端的 window
对象中。本文将介绍如何使用 envigor 。
安装
使用 npm 包管理工具进行安装:
npm install envigor
同时也需要安装 dotenv
,它是 envigor 的一个 peer 依赖项:
npm install dotenv
使用
以下示例代码将演示 envigor 的常规使用情况。
-- -------------------- ---- ------- ----- ------- - ------------------- --------- -------- ----- -------- ---- ------ ---- ------- ------- ------------ --------------------- -- ---- --------------------- -- --- ------------------- -- --- -------------------- -- -------
上面的代码先定义了一些环境变量,然后调用 inject()
方法将它们注入到全局变量中。在全局变量中,这些变量的名称与定义时所填写的相同,因此我们可以在代码的其他部分中使用它们。下面是一个更完整的示例:
-- -------------------- ---- ------- --------------------------- ----- ------- - ------------------- --------- ------------ - ----- ------- ------- --------------- ------- -------------- -------- ------------- -- -------- - ----- --------- -------- ----------------------- -- ---------- - ----- --------- --------- ---- - -- - ------------------- ---- ------------ ------------------------- ----------------- ---------------- ---- ------------- ------------------- --- --------------- -- ------------ --- ------------- - ----------------- -- ---------- --------------- -
上面的代码定义了三个环境变量,分别是 ENVIRONMENT
、API_URL
和 CLIENT_ID
。其中 ENVIRONMENT
是一个枚举类型的变量,其可选值为 'development'
、'test'
和 'production'
,默认值为 'development'
;API_URL
是一个字符串类型的变量,其默认值为 'http://localhost:3000'
;CLIENT_ID
是一个必填的字符串类型的变量,因此在通过 inject()
方法注入环境变量前,必须在环境中设置它的值。此外,这里使用了 { requireEmptyValues: true }
选项,它可以让 envigor 在环境变量中发现空值时抛出错误。
最后,我们在代码中使用注入的变量,并根据 ENVIRONMENT
的值输出一些信息。
总结
envigor 提供了一种简单而又实用的方式来管理环境变量。通过它,我们可以更加方便地进行配置管理,并减少了手动获取或设置环境变量的操作。希望这篇文章能够对你了解和使用 envigor 有所帮助。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60066e25a563576b7b1ecf1e