Search code examples
node.jstypescriptcompilation

TypeScript tsconfig settings for Node.js 10?


Does anyone know which target/libs are required for Node.js v10.x to use the built in async/await without the generators? I see a lot for node 8 but not with node 10.


Solution

  • As of Node.js 10.0.0, 100% of ES2018 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": "es2018"

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

    • "lib": ["es2018"]

      This tells TypeScript that it's okay to use functions and properties introduced in ES2018 or earlier. In practice, this means that you can use e.g. Promise.prototype.finally, Array.prototype.includes and String.prototype.padStart.

    The full config would thus be:

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

    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 12 you can see my similar answer for Node.js 12 here

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