doc: add path aliases typescript doc

PR-URL: #55766 Reviewed-By: Marco Ippolito <[email protected]> Reviewed-By: Jacob Smith <[email protected]> Reviewed-By: Paolo Insogna <[email protected]>
nodejs · Nov 9, 2024 · cbe09b5 · cbe09b5
1 parent 89aa838
commit cbe09b5
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/doc/api/typescript.md b/doc/api/typescript.md
@@ -172,14 +172,22 @@ To discourage package authors from publishing packages written in TypeScript,
 Node.js will by default refuse to handle TypeScript files inside folders under
 a `node_modules` path.
 
+### Paths aliases
+
+[`tsconfig` "paths"][] won't be transformed and therefore produce an error. The closest
+feature available is [subpath imports][] with the limitation that they need to start
+with `#`.
+
 [CommonJS]: modules.md
 [ES Modules]: esm.md
 [Full TypeScript support]: #full-typescript-support
 [`--experimental-strip-types`]: cli.md#--experimental-strip-types
 [`--experimental-transform-types`]: cli.md#--experimental-transform-types
+[`tsconfig` "paths"]: https://www.typescriptlang.org/tsconfig/#paths
 [`tsx`]: https://tsx.is/
 [`verbatimModuleSyntax`]: https://www.typescriptlang.org/tsconfig/#verbatimModuleSyntax
 [file extensions are mandatory]: esm.md#mandatory-file-extensions
 [full support]: #full-typescript-support
+[subpath imports]: packages.md#subpath-imports
 [the same way as `.js` files.]: packages.md#determining-module-system
 [type stripping]: #type-stripping