npm 包 env-to-script 使用教程

当构建一个 web 应用或者服务时,我们通常会使用到各种环境变量来配置不同的版本或者参数。在前端开发中,我们经常会使用像 axios 或者 fetch 这样的工具来请求 API,而其中的一些参数(例如 API 地址或者授权码)是需要在不同的环境中进行配置的。为了使得这些应用更加轻便和易于管理,我们可以使用一个名为 env-to-script 的 npm 包来将这些环境变量注入到 JavaScript 文件中。

安装

你可以使用 npm 或者 yarn 来安装 env-to-script

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

使用方法

1. 引入 env-to-script

在你的 HTML 文件中,你需要先导入 env-to-script

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

如果使用了类似 webpack 这样的构建工具,则需要使用 import 引入 env-to-script

2. 配置环境变量

为了将环境变量注入 JavaScript 文件中,我们需要定义这些变量,并使用 window.env 来进行传递。在一个 .env 文件中,你可以定义你所需要的所有环境变量:

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

在你的 index.html 文件中,添加如下代码:

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

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

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

在这个例子中,我们使用了模板字符串来将 .env 文件中的变量注入到 window.env 对象中。你会注意到这里使用了 ${name} 这样的语法,这是一种使用了 envsubst 的内联环境变量替换形式(虽然你并不必须使用环境变量进行替换)。

3. 使用环境变量

一旦完成了环境变量的设置,你就可以在你的 JavaScript 文件中通过访问 window.env 来引用所需要的环境变量了。

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

4. 打包构建

如果你使用了 webpack 或者其他类型的 JavaScript 打包器,你可能需要进行其他配置,才能够将环境变量注入到你的应用程序中。将环境变量传递给 JavaScript 是一个很常见的需求,在文档中也能够找到更多的具体细节。

示例

你可以在项目的 GitHub 仓库中查看更加详细的示例。这个示例展示了如何通过环境变量来设置不同 API 端点进行请求。

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

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

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

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

结论

env-to-script 让我们能够在前端代码中轻松地使用环境变量,无需担心环境变量变化导致代码出错的问题。而且,它对于传递复杂的环境变量也是非常方便的。

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


猜你喜欢

  • npm 包 for-each-safe 使用教程

    在前端开发中,经常需要遍历数组,但是 JavaScript 的 forEach 方法存在一定的问题,比如无法在遍历过程中进行中断操作。为了解决这个问题,可以使用 npm 包 for-each-safe...

    2 年前
  • NPM包 @kentcdodds/temp-react-live 的使用教程

    在前端开发中,我们经常需要通过示例代码来展示某个组件或者实现某个功能,同时也需要考虑到这些代码可以在线预览。这时候,一个好的工具可以让我们事半功倍。今天我想向大家推荐一个非常实用的NPM包:@kent...

    2 年前
  • npm 包 ccollazosplatzom 使用教程

    1. 简介 ccollazosplatzom 是一个快速生成随机社交媒体样式的npm包。它可以帮助用户快速方便地创建虚拟社交媒体卡片,填充内容并渲染出图片。 2. 安装 您可以使用 npm 命令来安装...

    2 年前
  • npm 包 express-final-response 使用教程

    在开发 Web 应用程序时,使用 Node.js 和 Express 作为后端框架是一种常见的选择。Express.js 是 Web 应用程序的流行框架之一,能够快速创建 RESTful API 和 ...

    2 年前
  • npm 包 fanyi-n 使用教程

    在前端开发中,我们常常需要进行多语言翻译,这时候一个好用的翻译库是非常必要的。而在众多翻译库中,有一个非常好用的 npm 包叫做 fanyi-n。它支持多种类型的翻译,包括文本、单词、句子、文章等。

    2 年前
  • npm 包 Furious-Monkey 使用教程

    Furious-Monkey 是一个实用的 npm 包,它是一种 JavaScript 程序,可用于生成随机的假数据,支持多种数据类型,例如姓名、邮箱、地址、手机号码等等。

    2 年前
  • npm 包 jencrypt 使用教程

    什么是 npm 包 jencrypt jencrypt 是一个轻量级的加密/解密 npm 包,可以用于前后端数据加密传输或存储。它基于 AES 对称加密算法,提供了简单的 API 接口,方便使用和调用...

    2 年前
  • npm 包 react-nested-tree 使用教程

    React-nested-tree 是一个 React UI 组件库,它提供了一个可嵌套的树形结构,并支持拖放和自定义视图,是开发前端应用不可缺少的工具之一。本文将为你详细介绍该组件库的使用方法和注意...

    2 年前
  • npm 包 words-en 使用教程

    在前端开发和自然语言处理等领域,经常需要使用英语单词。为了方便地获取英语单词,我们可以使用 npm 包 words-en。本文将介绍该包的使用教程,帮助读者快速了解并使用该包。

    2 年前
  • npm 包 dead-simple-grid-css 使用教程

    在前端开发中,网格布局是一个重要的设计工具,它可以帮助我们轻松地实现网页布局,使网站具有可读性,布局合理。为此,npm 社区推出了 dead-simple-grid-css 开源项目,该项目是一种基于...

    2 年前
  • npm 包 node-xml-stream 使用教程

    在前端开发中,有时候需要在后端使用 XML 数据,在这种情况下,node-xml-stream 是一个非常有用的 npm 包。本文将详细介绍 node-xml-stream 的使用方法,包括安装,使用...

    2 年前
  • npm 包 @graphql-guru/babel-tasks 使用教程

    简介 @graphql-guru/babel-tasks 是一个基于 Babel 的任务管理器,为开发者提供了一个方便的方式来创建和运行 Babel 任务。该任务管理器是专门为 GraphQL 开发者...

    2 年前
  • npm 包 ekiras-angular-social-auth 使用教程

    本文将为大家介绍如何使用npm包ekiras-angular-social-auth,这是一个Angular社交认证库,在实践开发中十分实用。我们将从安装、配置、使用,以及有关社交认证常见问题的解决方...

    2 年前
  • NPM 包 ekiras-markdown-it 使用教程

    简介 ekiras-markdown-it 是一款基于 Markdown 语法的解析器,可以在前端页面中方便地解析 Markdown 文本,并将其转换为 HTML 标签,实现富文本展示功能。

    2 年前
  • npm 包 homebridge-dotti 使用教程

    在这篇文章中,我们将介绍如何使用 npm 包 homebridge-dotti,这是一个用于控制 Dotti 智能手环的 homebridge 插件,可用于构建智能家居应用程序。

    2 年前
  • npm 包 react-loading-indicator-overlay 使用教程

    react-loading-indicator-overlay 是一个方便易用的 React 组件库,用于在页面加载或请求时显示加载动画或进度条。本文将介绍如何使用这个 npm 包,包括安装、基本使用...

    2 年前
  • npm 包 tr-library 使用教程

    前言 在前端开发的过程中,使用 npm 包已经成为了一种常见的方式。使用 npm 包可以方便我们管理以及使用各种第三方库,让我们的开发效率得到很大程度的提高。在本文中,我们将介绍一个名为 tr-lib...

    2 年前
  • npm 包 @trasukg/state-machine 使用教程

    在前端开发中,状态机是一种重要的编程模型。它可以帮助我们更好地管理复杂的状态,并让代码更易于维护。在这篇文章中,我们将介绍一个强大的 npm 包 @trasukg/state-machine,它可以让...

    2 年前
  • npm 包 generator-vue-component-bundle 使用教程

    简介 generator-vue-component-bundle 是一个能够生成 Vue 组件的 npm 包生成器。通过该工具,开发者可快速创建 Vue 组件,包含了单文件组件、测试脚本、文档和样式...

    2 年前
  • npm 包 ng-emphasis 使用教程

    在前端开发中,文本的强调效果是常用的样式之一。然而在实现中,手动给文本添加 font-weight 或 color 样式是比较繁琐且难以维护的一种方式。这时候,使用 npm 包 ng-emphasis...

    2 年前

相关推荐

    暂无文章