npm 包 await-env 使用教程

前言

发布前端代码需要考虑很多环境变量的配置,比如数据库地址、API 地址、应用程序 KEY 等,这些不同环境的配置项需要单独管理,而不是将其硬编码在代码中。传统的做法是使用 node.js 内置模块 process.env 来访问环境变量,然后使用配置文件或者写在代码里面的方式引用。但这种方式过于繁琐,而且在实际使用中容易出现错误。随着 npm 包的不断发展,我们可以使用一些 npm 包来降低开发和管理复杂度,await-env 是其中一种常用的工具包。

await-env 是什么?

await-env 是一个 node.js 模块,用于解决读取环境变量的问题。这个模块提供了一种方法,可以等待环境变量加载完成之后再去使用这些环境变量。这对于需要从环境变量中读取敏感信息的应用程序来说尤其重要,比如从 config 文件中读取数据库密码、API 密钥等。

安装

要使用 await-env 包,首先需要将其安装到你的项目中。我们知道可以使用 npm install 命令来安装 npm 包,所以在你的项目的根目录下执行如下命令即可:

--- ------- --------- ------

使用示例

让我们来看一下如何使用 await-env。假设我们需要在我们的工程代码中使用一个环境变量 'MY_VAR',我们可以通过以下方式获取并使用相应的环境变量:

----- -------- - ---------------------
 
----- -------- ------ -
  ----- ------------------- -- ----- ------ --------
 
  -- ----
  ----- ----- - -------------------
 
  -------------------
-
 
----------------------------

在上例中,我们首先导入了 await-env 模块。然后,我们在异步函数 main() 中使用 await awaitEnv('MY_VAR'),这会导致 awaitEnv 暂停执行,直到环境变量 ‘MY_VAR’ 被加载。然后我们可以通过 process.env 属性来访问环境变量 'MY_VAR' 值并使用它。

参数

awaitEnv 接受多个参数,在这里提及其中两个比较特殊的:

  • key: 等待加载的环境变量名称,必填项。
  • options: 可选,awaitEnv 选项的其它参数。

这里是一个使用 options 参数的示例代码:

----- -------- - ---------------------
 
----- -------- ------ -
  ----- ------------------ - -------- -- ------ --- --- -- -- - ----- -----
 
  -- ----
  ----- ----- - -------------------
 
  -------------------
-
 
----------------------------

在这个示例中,我们使用了传递给 options 参数的两个属性:

  • retries: await-env 尝试等待 key 时的最大尝试次数,如果尝试请求数超过此限制,则 await-env 抛出错误。默认值为 3
  • delay: await-env 尝试等待 key 时的延迟时间(毫秒)。默认值为 1000ms。如果设置为 0,则 await-env 立即重试等待。

结论

await-env 是一个非常有用的 npm 包,允许您等待环境变量加载完成后在应用中使用它们。这个包可以为所有需要读取环境变量的应用程序提供一个安全且方便的解决方案,这对于像数据库密码和API 密钥这样的敏感信息特别重要。

参考

结束语

在这篇文章中,我们介绍了使用 await-env 包来处理 node.js 应用程序中的环境变量,以及如何在项目中安装和使用它。我们还演示了如何使用此包来等待环境变量加载完成。谢谢阅读,希望你们有所收获。

来源:JavaScript中文网 ,转载请联系管理员! 本文地址:https://www.javascriptcn.com/post/6005723881e8991b448e858b


猜你喜欢

  • npm 包 samcalc 使用教程

    在前端开发中,常常需要进行数字计算,比如价格计算、数据处理等,如果每次都手动完成可能会比较繁琐,而 npm 包 samcalc 就是一个便于前端数字计算的工具库,能够大大方便我们的开发工作。

    3 年前
  • npm 包 @wyracocha/wy-env 使用教程

    简介 @wyracocha/wy-env 是一款前端开发常用的 npm 包,它提供了一些常用的环境变量判断和配置操作函数,可以帮助我们在开发过程中更加方便地根据环境变量进行不同的操作,例如应对不同的环...

    3 年前
  • npm 包 hubot-boldbold 使用教程

    简介 hubot-boldbold 是一个 npm 包,它是 Hubot 框架上基于 bold 消息格式的增强版,提供了更多的消息格式和指令来满足聊天机器人的需求。

    3 年前
  • npm 包 leaflet-smooth-heatmap 使用教程

    介绍 在前端开发过程中,我们常常需要在地图上展示数据,其中热力图是常用的一种展示方式。而 leaflet-smooth-heatmap 就是一个可以帮助我们实现热力图功能的 npm 包。

    3 年前
  • npm 包 schoox-api-wrapper 使用教程

    介绍 schoox-api-wrapper 是一个基于 Node.js 平台的 npm 包,可用于与 Schoox Learning Management System 的 API 进行交互。

    3 年前
  • npm 包 demovitessesam 使用教程

    在前端开发中,如何优化网页的性能是一个关键问题。其中一个解决方案就是利用 demovitessesam 这个开源 npm 包,它可以帮助我们检测网页的速度并作出优化建议。

    3 年前
  • npm 包 dropdown-test-vitesse-sam 使用教程

    前言 在前端开发中,我们经常会需要实现下拉框的功能,在许多框架中也都内置了下拉框组件,但如果需要轻量级和高度自定义的下拉框组件,我们可以使用 npm 包 dropdown-test-vitesse-s...

    3 年前
  • NPM 包 r8s-cli 使用教程

    简介 r8s-cli 是一款为 React Native 提供代码压缩、混淆及资源优化的命令行工具,其主要功能包括: js 文件代码压缩及混淆; assets 资源压缩及转换,比如将 png 文件进...

    3 年前
  • npm 包 play-torrent 使用教程

    在现今互联网的时代,通过种子下载文件已经成为了一种非常便捷的方式,然而,一旦种子文件下载完成,我们又需要一个好用的播放器来播放视频文件。本教程将介绍一款名为 play-torrent 的 npm 包,...

    3 年前
  • npm 包 ng-ai-form 使用教程

    在前端开发中,表单是很常见的一种交互方式,但是处理表单数据却是一件麻烦的事情。为了解决这个问题,有很多开发者都选择了使用 ng-ai-form 这个 npm 包来处理表单数据。

    3 年前
  • npm 包 vuelma-form 使用教程

    前言 在前端开发中,表单是必不可少的组件之一。然而,在实现表单功能时,很多开发者都会遇到重复性高、代码量大、难以维护等问题。为了解决这些问题,一些前端开发工程师们为大家带来了众多实用的 npm 包。

    3 年前
  • npm包airtame-gooey使用教程

    简介 npm是一个非常流行的前端包管理器,其中有许多不同类型的包,例如用于前端开发的框架、库、工具等。其中,airtame-gooey是一个可以帮助开发人员快速创建漂亮、易于使用的用户界面的npm包。

    3 年前
  • npm 包 generator-mytime-ng2component 使用教程

    随着前端技术的进步,我们需要使用越来越多的工具来保持代码的组织和可维护性。npm 是一个包管理器,它提供了许多功能来方便我们工作。generator-mytime-ng2component 是一个 n...

    3 年前
  • npm包json-server-plus使用教程

    在前端开发中,经常需要模拟后端的API来进行调试和测试。为了满足这个需求,有一些工具可以帮助我们快速地搭建一个模拟的API服务器。其中,json-server-plus就是一个非常好用的npm包。

    3 年前
  • npm包@shoesofprey/three-orbit-controls-es 使用教程

    介绍 @shoesofprey/three-orbit-controls-es 是一个 JavaScript 库,它为three.js提供了一种自由地控制相机的方式。

    3 年前
  • NPM 包: printname 使用教程

    介绍 在前端开发过程中,我们经常需要在控制台或者页面输出一些简单的提示或者信息。使用 console.log() 可以实现这个功能,但是当我们输出的信息比较复杂或者需要格式化的时候,就需要另一种更加高...

    3 年前
  • npm 包 react-native-swipeview-flat 使用教程

    React Native 是一种基于 JavaScript 的开源移动应用开发框架,它支持跨平台开发,可以使用一套代码同时创建 Android 和 iOS 应用。在开发中,我们经常需要实现类似左滑菜单...

    3 年前
  • npm 包 establishment-node-service-core 使用教程

    什么是 npm? npm 是 Node.js 的默认包管理器,用于安装、共享和发布 Node.js 模块。npm 使开发者可以轻松地共享和重用代码,并便于构建更加强大的应用程序。

    3 年前
  • `npm` 包 `@ardentlabs/react-native-emoji` 使用教程

    在移动开发中,表情符号可以让用户更好地表达自己的情感和想法,因此在 React Native 中使用表情符号也是开发者需要考虑的一点。而 @ardentlabs/react-native-emoji ...

    3 年前
  • npm 包 establishment-node-service-emulator 使用教程

    在前端开发中,为了测试和调试接口,我们经常会需要使用一些模拟服务器。然而,手写模拟服务器的过程既费时又费力。因此,本文介绍了一个npm包—— establishment-node-service-em...

    3 年前

相关推荐

    暂无文章