npm 包 env-check 使用教程

阅读时长 5 分钟读完

介绍

env-check 是一个用于检测环境变量的 npm 包。它可以帮助你在应用程序启动时,快速确定它所依赖的环境变量是否存在。如果环境变量未设置,则会显示一个警告或错误信息,让你尽早地发现问题并解决它。

安装

在命令行中运行以下命令:

使用方法

在 index.js 文件中引入 env-check 包:

设置应用程序依赖的环境变量和它们所需要的类型:

在应用程序启动时调用 envCheck 函数:

如果所有环境变量都存在且类型正确,则无输出。如果任一环境变量未设置或类型不正确,则会显示一个警告或错误消息。

高级用法

忽略特定环境变量

你可能有一些环境变量,你不想在启动应用程序时检查。你可以使用 ignoreEnvVars 参数来防止这些环境变量被检查。

自定义警告或错误信息

如果你的应用程序对某些环境变量有额外的要求,你可以自定义有关这些要求的警告或错误信息。

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

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

示例

下面的示例使用 env-check 检查前端应用程序是否设置了正确的环境变量。

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

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

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

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

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

这样,如果启动应用程序时缺少任何环境变量,则会显示警告或错误消息。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60066e21a563576b7b1ece44

纠错
反馈