npm 包 document-env-vars 使用教程

介绍

document-env-vars 是一个 npm 包,用于将环境变量注入到 HTML 文件中的 JavaScript 变量中。它可以让你在编译期间,自动将环境变量注入到 HTML 文件中,从而避免在运行时读取环境变量的麻烦。

安装

要安装 document-env-vars,可以使用 npm 命令:

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

使用教程

  1. 在项目根目录下创建 .env.local 文件,将你需要的环境变量定义在该文件中:

    ---------------------------
  2. 在你的 HTML 文件中,使用如下方式定义一个 JavaScript 变量来注入环境变量:

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

    注意: 在这个例子中,我们需要手动引入 env.js 文件。如果你的项目使用了打包工具,如 webpack 或者 rollup,你可以使用文件加载器来自动注入该文件。

  3. 在 webpack 配置文件中,引入 document-env-vars:

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

    在该配置文件中,我们向 DocumentEnvVars 构造函数传入了两个参数:

    • path:表示的是 .env.local 文件的路径,你也可以指定其他的名称。
    • variableName:表示希望我们创建的 JavaScript 全局变量的名称。在这里我们定义为 env。
  4. 运行 webpack 打包你的应用。现在你可以在 HTML 文件中访问定义的环境变量。

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

深度解析

在这个教程中,我们使用了 webpack 插件来自动注入环境变量到 HTML 文件中。作为一个前端开发者,webpack 的使用是必备的技能。

DocumentEnvVars 插件使用了 html-webpack-plugin 这个插件来获取 HTML 文件,在编译过程中自动插入注入环境变量的 JavaScript 文件。

结论

document-env-vars 可以让你在编译期间自动注入环境变量到 HTML 文件中,以避免在运行时读取环境变量。

这是一个非常有用的工具,特别是在打包应用程序,或者需要在多个环境下部署时。

希望这个教程对你有帮助!

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


猜你喜欢

  • npm 包 cordova-plugin-background-mode-jk 使用教程

    前言 cordova-plugin-background-mode-jk 是一款适用于 Cordova 应用开发的 npm 包,用于实现应用在后台运行的功能。在一些特定场景下,比如音乐播放器、位置追踪...

    2 年前
  • npm 包 has-setter 使用教程

    在前端开发中,有时候我们需要对某个对象的值做出修改,但是又不希望直接修改这个对象的值,因为这样可能会改变它的其他属性,造成不可预测的结果。这时候,我们可以使用 npm 包 has-setter。

    2 年前
  • npm 包 gulp-ex-css-url-adjuster 使用教程

    前言 在前端开发中,大多数情况下我们需要用到 gulp 来处理 css 文件,而在一些情况下,我们需要修改 css 文件中某些图片的路径,这时候就需要使用到 gulp-ex-css-url-adjus...

    2 年前
  • npm 包 mkw-test-package 使用教程

    介绍 mkw-test-package 是一个用于前端开发的 npm 包,内置了多个常用的前端工具函数。这些函数可以大幅提高开发效率,减少重复劳动,同时也减少了代码错误的可能性。

    2 年前
  • npm 包 react-grid-detail-expansion 使用教程

    前言 随着互联网的飞速发展,前端技术已经变得尤为重要。其中,基于 React 开发的 web 应用已经成为了主流。在 React 中,使用组件来构建 UI 是一种常见的方式。

    2 年前
  • npm 包 vue-collapse 使用教程

    简介 在构建网页应用程序时,我们经常需要添加交互元素来提高用户体验。其中展开或收缩区域是最常见的交互元素之一。用于此的NPM包中,vue-collapse是一个十分实用的库。

    2 年前
  • npm 包 cf-upload-file 使用教程

    随着 Web 应用的广泛应用和复杂性的增加,文件上传已成为 Web 应用中基本的功能之一。npm 包 cf-upload-file 是一个专门用于文件上传的 JavaScript 库,它使得文件上传的...

    2 年前
  • npm 包 slack-ioa 使用教程

    在前端中,我们经常需要与其他人进行沟通和协作,而 Slack 是很多团队喜欢使用的一种在线聊天工具。slacK-ioa 包就是一个基于 Slack 的工具,它可以帮助我们在 Slack 上快速地创建机...

    2 年前
  • npm 包 npm-install-check 使用教程

    在前端的开发中,我们通常需要使用很多的 npm 包,而这些包的版本管理和依赖关系十分复杂,一个小小的版本问题可能会导致整个项目的构建失败。而 npm-install-check 包可以为我们解决这些问...

    2 年前
  • npm 包 use-preact 使用教程

    在前端开发中,使用预编译的JavaScript框架能够极大地提高开发效率和开发体验。Preact是一个轻量级的React替代方案,它只有3kb大小,提供了和React几乎一样的API和生命周期,能够快...

    2 年前
  • npm 包 @bouzuya/cyclejs-history-driver 使用教程

    什么是 @bouzuya/cyclejs-history-driver? @bouzuya/cyclejs-history-driver 是一个基于 Cycle.js 的自定义驱动程序 (custom...

    2 年前
  • npm包cdlist使用教程

    简介 npm(Node Package Manager)是一个Node.js的包管理器,提供了丰富的包资源供开发人员使用。而cdlist就是其中一个常用的npm包,该包用于实现一个简单的列表选择功能。

    2 年前
  • npm 包 mean2 使用教程

    MEAN2 指的是 MongoDB、Express、Angular 和 Node.js。mean2 是现代 web 应用程序的一种强大的解决方案。本教程旨在向前端开发人员介绍如何使用 npm 包 me...

    2 年前
  • npm 包 neutrino-preset-standardreact 使用教程

    简介 neutrino-preset-standardreact 是一种使用 React 和标准 Webpack 配置的预设,可使用 neutrino 构建和构建 React 应用程序和组件。

    2 年前
  • npm 包 m-rem 使用教程

    在前端开发中,我们常常需要根据不同的屏幕尺寸自动适配页面的字体大小和元素大小,这时候就需要使用 m-rem 这个 npm 包。这个包可以让我们快速地将设计稿中的 px 值转换成 rem,从而实现页面的...

    2 年前
  • npm 包 package-settings 使用教程

    在前端开发中,我们经常会使用 npm 包来完成各种任务。npm 包是一种现代的软件包管理工具,可以帮助我们快速安装和共享代码。本文将介绍一个非常有用的 npm 包 package-settings,它...

    2 年前
  • npm 包 react-popover-portal 使用教程

    React-popover-portal 是一个基于 React 开发的弹窗组件,支持多种显示方式,可以让你方便地创建各种弹窗。它具有高度的可配置性和扩展性,不仅支持纯 JS 配置弹窗内容,还支持 J...

    2 年前
  • npm 包 vinyl-changes-stream 使用教程

    简介 在前端开发中,我们经常会用到构建工具来进行代码的打包、压缩、编译等操作。而构建工具中的一个重要的概念就是流(Stream),它可以将我们的操作变成一个可读、可写的流,方便我们进行文件的操作。

    2 年前
  • npm 包 @ryo_suga/babel-preset-ryosuga 使用教程

    前言 在 JavaScript 开发过程中,我们经常会用到 Babel 进行代码转换。Babel 是一个能够将 ES6+ 代码转换成浏览器或 Node.js 可以运行的 JavaScript 代码的工...

    2 年前
  • npm 包 angular2-round-slider 使用教程

    简介 angular2-round-slider 是一款基于 Angular 2 的圆形滑块组件。该组件可以被用于日程安排、音量控制、图像调整等场景中。本文将为您介绍如何安装、使用和自定义该组件。

    2 年前

相关推荐

    暂无文章