TypeScript tsconfig settings for Node.js 12?

by

As of Node.js 12.0.0, 100% of ES2019 is supported. If you know that you are targeting that version or newer, the optimal config would look like this:

  • "module": "commonjs"

    Node.js is on its way to add ES-Modules, but for now we’ll have to stick with CommonJS.

  • "target": "es2019"

    This tells TypeScript that it’s okay to output JavaScript syntax with features from ES2019. In practice, this means that it will e.g. output object rest/spread properties & async/await syntax instead of embedding a polyfill.

  • "lib": ["es2019", "es2020.bigint", "es2020.string", "es2020.symbol.wellknown"]

    This tells TypeScript that it’s okay to use functions and properties introduced in ES2019 or earlier. In practice, this means that you can use e.g. String.prototype.trimStart and Array.prototype.flat.

    In addition to ES2019, Node.js 12 also supports BigInt & matchAll from ES2020, therefor we include the additional definitions from ES2020.

The full config would thus be:

{
  "compilerOptions": {
    "lib": ["es2019", "es2020.bigint", "es2020.string", "es2020.symbol.wellknown"],
    "module": "commonjs",
    "target": "es2019"
  }
}

If you are targeting Node.js 12.9.0 or newer, you can simply specify "lib": ["es2020"] as that version supports all new functions and properties introduced in ES2020. It doesn’t support the new JavaScript syntax though, so you still have to stay on "target": "es2019".

The full config would thus be:

{
  "compilerOptions": {
    "lib": ["es2020"],
    "module": "commonjs",
    "target": "es2019"
  }
}

If you are running Node.js 18 you can see my similar answer for Node.js 18 here

If you are running Node.js 16 you can see my similar answer for Node.js 16 here

If you are running Node.js 14 you can see my similar answer for Node.js 14 here

If you are running Node.js 10 you can see my similar answer for Node.js 10 here

If you are running Node.js 8 you can see my similar answer for Node.js 8 here

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. using process.env in TypeScript
  12. How to consume npm modules from typescript?
  13. Augmentations for the global scope can only be directly nested in external modules or ambient module declarations(2669)
  14. Importing node-modules with TypeScript
  15. tsc is not recognized as internal or external command
  16. Cannot find module ‘angular2/angular2’
  17. How to run TypeScript files from command line?
  18. “Type ‘string | string[]’ is not assignable to type ‘string’
  19. Typescript Error: Property ‘user’ does not exist on type ‘Request’
  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. Automatically start forever (node) on system restart
  28. Parsing a CSV file using NodeJS [closed]
  29. Differences between express.Router and app.get?
  30. How to know if user is logged in with passport.js?

Leave a Comment