using process.env in TypeScript

by

Once you have installed @types/node in your project, you can tell TypeScript exactly what variables are present in your process.env:

environment.d.ts

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

// If this file has no import/export statements (i.e. is a script)
// convert it into a module by adding an empty export statement.
export {}

Usage:

process.env.GITHUB_AUTH_TOKEN; // $ExpectType string

This method will give you IntelliSense, and it also takes advantage of string literal types.

Note: the snippet above is module augmentation. Files containing module augmentation must be modules (as opposed to scripts). The difference between modules and scripts is that modules have at least one import/export statement.

In order to make TypeScript treat your file as a module, just add one import statement to it. It can be anything. Even export {} will do.

More Related Contents:

  1. TypeScript getting error TS2304: cannot find name ‘ require’
  2. The difference between “require(x)” and “import x”
  3. Extend Express Request object using Typescript
  4. Avoid “current URL string parser is deprecated” warning by setting useNewUrlParser to true
  5. Timeout in async/await
  6. Can’t run my Node.js Typescript project TypeError [ERR_UNKNOWN_FILE_EXTENSION]: Unknown file extension “.ts” for /app/src/App.ts
  7. How to NodeJS require inside TypeScript file?
  8. Extending TypeScript Global object in node.js
  9. Module not found: Error can’t resolve ‘child_process’, how to fix?
  10. What TypeScript configuration produces output closest to Node.js 14 capabilities?
  11. How to consume npm modules from typescript?
  12. Augmentations for the global scope can only be directly nested in external modules or ambient module declarations(2669)
  13. Importing node-modules with TypeScript
  14. tsc is not recognized as internal or external command
  15. Cannot find module ‘angular2/angular2’
  16. How to run TypeScript files from command line?
  17. “Type ‘string | string[]’ is not assignable to type ‘string’
  18. Typescript Error: Property ‘user’ does not exist on type ‘Request’
  19. TypeScript tsconfig settings for Node.js 12?
  20. How to force tsc to ignore node_modules folder?
  21. What is the pwa-node type launch configuration on VSCode?
  22. What TypeScript configuration produces output closest to Node.js 18 capabilities?
  23. recommended typescript config for node 8
  24. One project with multiple package.json files
  25. Go to the TypeScript source file instead of the type definition file in VS Code
  26. TypeScript tsconfig settings for Node.js 10?
  27. Is there a compatibility list for Angular / Angular-CLI and Node.js?
  28. Where is nodejs log file?
  29. Node.js & Amazon S3: How to iterate through all files in a bucket?
  30. How to chain a variable number of promises in Q, in order?

Leave a Comment