doc: add suggested tsconfig for type stripping

PR-URL: nodejs#55534 Reviewed-By: Zeyu "Alex" Yang <[email protected]> Reviewed-By: Yagiz Nizipli <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]> Reviewed-By: Chemi Atlow <[email protected]> Reviewed-By: Gireesh Punathil <[email protected]>
louwers · Nov 2, 2024 · ee3fac4 · ee3fac4
1 parent cb20aa5
commit ee3fac4
Showing 1 changed file with 15 additions and 0 deletions.
diff --git a/doc/api/typescript.md b/doc/api/typescript.md
@@ -68,6 +68,21 @@ 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.
 
+Type stripping works with most versions of TypeScript
+but we recommend version 5.7 or newer with the following `tsconfig.json` settings:
+
+```json
+{
+  "compilerOptions": {
+     "target": "esnext",
+     "module": "nodenext",
+     "allowImportingTsExtensions": true,
+     "rewriteRelativeImportExtensions": true,
+     "verbatimModuleSyntax": true
+  }
+}
+```
+
 ### Determining module system
 
 Node.js supports both [CommonJS][] and [ES Modules][] syntax in TypeScript