doc: add suggested tsconfig for type stripping

nodejs · Oct 25, 2024 · 8377c51 · 8377c51
1 parent 2505e21
commit 8377c51
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/doc/api/typescript.md b/doc/api/typescript.md
@@ -68,6 +68,19 @@ By intentionally not supporting syntaxes that require JavaScript code
 generation, and by replacing inline types with whitespace, Node.js can run
 TypeScript code without the need for source maps.
 
+The suggested `tsconfig.json` settings for type stripping are:
+
+```json
+{
+  "compilerOptions": {
+     "module": "nodenext",
+     "allowImportingTsExtensions": true,
+     "rewriteRelativeImportExtensions": true,
+     "verbatimModuleSyntax": true
+  }
+}
+```
+
 ### Determining module system
 
 Node.js supports both [CommonJS][] and [ES Modules][] syntax in TypeScript