OSSForks/node
1
0
Fork 0
mirror of https://github.com/zebrajr/node.git synced 2026-01-15 12:15:26 +00:00
Code Issues Actions 8 Packages Projects Releases Wiki Activity

doc: recommend setting noEmit: true in tsconfig.json

Browse Source 
PR-URL: https://github.com/nodejs/node/pull/57320
Fixes: https://github.com/nodejs/node/issues/57294
Reviewed-By: Marco Ippolito <marcoippolito54@gmail.com>
Reviewed-By: Moshe Atlow <moshe@atlow.co.il>
This commit is contained in:
Steven
2025-03-06 17:30:59 -05:00
committed by GitHub
parent a7909014f7
commit 5401ac687c
1 changed files with 5 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
doc/api/typescript.md
View File

@@ -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