doc: recommend setting noEmit: true in tsconfig.json

styfle · aduh95 · commit 5c9f1a40e44a · 2025-03-09T11:38:43.000+01:00
PR-URL: #57320 Fixes: #57294 Reviewed-By: Marco Ippolito <marcoippolito54@gmail.com> Reviewed-By: Moshe Atlow <moshe@atlow.co.il>
diff --git a/doc/api/typescript.md b/doc/api/typescript.md
@@ -81,6 +81,7 @@ but we recommend version 5.8 or newer with the following `tsconfig.json` setting
 ```json
 {
   "compilerOptions": {
+     "noEmit": true, // Optional - see note below
      "target": "esnext",
      "module": "nodenext",
      "rewriteRelativeImportExtensions": true,
@@ -90,6 +91,10 @@ but we recommend version 5.8 or newer with the following `tsconfig.json` setting
 }
 ```
 
+> \[!NOTE]
+> Use the `noEmit` option if you intend to only execute `*.ts` files, for example a build script.
+> You won't need this flag if you intend to distribute `*.js` files for performance reasons.
+
 ### Determining module system
 
 Node.js supports both [CommonJS][] and [ES Modules][] syntax in TypeScript
