在TypeScript中使用process.env

Question

如何在TypeScript中读取节点环境变量？

如果我使用process.env.NODE_ENV我有这个错误:

Property 'NODE_ENV' does not exist on type 'ProcessEnv'

我安装@types/node但没有帮助.

Answer 1

@types/node在项目中安装完之后，您可以准确地告诉TypeScript您的变量中存在哪些变量process.env：

environment.d.ts

declare global {
  namespace NodeJS {
    interface ProcessEnv {
      GITHUB_AUTH_TOKEN: string;
      NODE_ENV: 'development' | 'production';
      PORT?: string;
      PWD: string;
    }
  }
}

此方法将为您提供IntelliSense，并且还利用了字符串文字类型。

注意：以上代码段是模块扩充。包含模块扩展的文件必须是模块（而不是脚本）。模块和脚本之间的区别在于，模块至少具有一个import / export语句。

为了使TypeScript将文件视为模块，只需向其中添加一个import语句。可以是任何东西。甚至import * as ts from 'typescript'会做。

Answer 2

1.创建.env文件

# Contents of .env file
AUTHENTICATION_API_URL="http://localhost:4000/login"
GRAPHQL_API_URL="http://localhost:4000/graphql"

2.将.env文件转换成process.env与dotenv

我们可以利用dotenv来设置特定于环境的process.env变量。config.ts在您的src/目录中创建一个名为的文件并按如下方式填充：

// Contents of src/config.ts

import {config as configDotenv} from 'dotenv'
import {resolve} from 'path'

switch(process.env.NODE_ENV) {
  case "development":
    console.log("Environment is 'development'")
    configDotenv({
      path: resolve(__dirname, "../.env.development")
    })
    break
  case "test":
    configDotenv({
      path: resolve(__dirname, "../.env.test")
    })
    break
  // Add 'staging' and 'production' cases here as well!
  default:
    throw new Error(`'NODE_ENV' ${process.env.NODE_ENV} is not handled!`)
}

注意： 此文件需要通过 import './config'（放置在所有其他导入之前）导入您的最顶层文件，可能是您的 src/index.ts

3. 检查 ENV 变量并定义 IProcessEnv

结合上述几种方法后，我们可以添加一些运行时检查以确保我们声明的IProcessEnv接口反映了我们.env.*文件中设置的 ENV 变量。下面的内容也可以在src/config.ts

// More content in config.ts
const throwIfNot = function<T, K extends keyof T>(obj: Partial<T>, prop: K, msg?: string): T[K] {
  if(obj[prop] === undefined || obj[prop] === null){
    throw new Error(msg || `Environment is missing variable ${prop}`)
  } else {
    return obj[prop] as T[K]
  }
}
// Validate that we have our expected ENV variables defined!
['AUTHENTICATION_API_URL', 'GRAPHQL_API_URL'].forEach(v => {
  throwIfNot(process.env, v)
})

export interface IProcessEnv {
  AUTHENTICATION_API_URL: string
  GRAPHQL_API_URL: string
}

declare global {
  namespace NodeJS {
    interface ProcessEnv extends IProcessEnv { }
  }
}
   

这将为我们提供适当的 IntelliSense/tslint 类型检查，以及在部署到各种环境时的一些理智。

请注意，这也适用于 ReactJS 应用程序（与NodeJS服务器应用程序相反）。您可以省略步骤 (2)，因为这是由 处理的create-react-app。

Answer 3

我知道这会帮助那些搜索此内容但找不到简单答案的人，为什么你的proccess.env变量会让你的编译器发出呜呜声：

安装@types/node：

npm i @types/node

然后，无论您将 env 作为字符串包含在何处，请执行以下操作：

process.env.YOUR_ENV ?? ''

双问号允许您检查空/未定义。

Answer 4

无法保证在Node进程中有什么(如果有的话)环境变量可用 - NODE_ENV变量只是一个由Express推广的约定,而不是内置于Node本身的内容.因此,将它包含在类型定义中是没有意义的.相反,他们定义process.env如下:

export interface ProcessEnv {
    [key: string]: string | undefined
}

这意味着process.env可以使用字符串索引以获取字符串(或者undefined,如果未设置变量).要修复错误,您必须使用索引语法:

let env = process.env["NODE_ENV"];

或者,正如jcalz在评论中指出的那样,如果您使用的是TypeScript 2.2或更高版本,则可以使用点语法访问类似上面定义的索引类型 - 在这种情况下,您的代码应该按原样工作.

Answer 5

只需在使用前添加process.env.NODE_ENV以下行：

declare var process : {
  env: {
    NODE_ENV: string
  }
}

Answer 6

这是一个简短的函数，它保证将 process.env 值作为字符串提取——否则会抛出错误。

对于更强大（但也更大）的东西，这里的其他人建议使用env-var。

/**
 * Returns value stored in environment variable with the given `name`.
 * Throws Error if no such variable or if variable undefined; thus ensuring type-safety.
 * @param name - name of variable to fetch from this process's environment.
 */
export function env(name: string): string {
  const value = process.env[name];

  if (!value) {
    throw new Error(`Missing: process.env['${name}'].`);
  }

  return value;
}

然后，您应该能够编写如下代码：

let currentEnvironment: string;
currentEnvironment = env('NODE_ENV');

Answer 7

对我有用的是，在我想使用的任何地方，process.env我首先导入dotenv并调用config()它。另外，请记住在末尾追加!并确保在您的.env文件中定义了该属性

import dotenv from 'dotenv';

dotenv.config();

export const YOUR_ATTRIBUTE = process.env.YOUR_ATTRIBUTE!;

Answer 8

1. 通过运行安装@types/nodenpm i @types/node
2. 添加"types": [ "node" ]到 tsconfig.json 文件中的compilerOptions部分。

Answer 9

创建一个类似 global.d.ts 的文件

\n

\ndeclare global {\n  namespace NodeJS {\n    interface ProcessEnv {\n      SECRET: string;\n    }\n  }\n}\nexport {};\n\n

\n

教程由 Christian H\xc3\xb6ller 提供

\n

Answer 10

使用打字稿最新版本执行后：

npm install --save @types/node

您可以process.env直接使用。

console.log(process.env["NODE_ENV"])

如果已设置，您将看到预期的结果NODE_ENV。

Answer 11

您可以为此使用类型断言

有时，您会遇到比TypeScript更了解值的情况。通常，当您知道某个实体的类型可能比其当前类型更具体时，就会发生这种情况。

类型断言是一种告诉编译器“相信我，我知道我在做什么”的方法。类型断言就像其他语言中的类型转换一样，但是不执行任何特殊的数据检查或重构。它对运行时间没有影响，仅由编译器使用。TypeScript假定您（程序员）已经执行了所需的任何特殊检查。

例

const nodeEnv: string = (process.env.NODE_ENV as string);
console.log(nodeEnv);

另外，您可能会发现像env-var这样的库更适合此特定目的-

“使用正确的类型加载和清理node.js中的环境变量的解决方案”