docs(cjs): add compilation caveats

privatenumber · Oct 16, 2024 · 524cb77 · 524cb77
1 parent 7f8a051
commit 524cb77
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 1 deletion.
diff --git a/docs/dev-api/register-cjs.md b/docs/dev-api/register-cjs.md
@@ -2,6 +2,12 @@
 
 The CommonJS Register API allows you to manually register the enhancement at runtime. But note, this only affects CommonJS modules (`.cjs`/`.cts`, and `.js`/`.ts` when `package.json#type` is unset or `commonjs`).
 
+::: warning Caveats
+
+- `import()` calls in the loaded files are not enhanced because they're handled by Node's ESM hook. Use with the [`ESM Register API`](/dev-api/register-esm).
+- Because it compiles ESM syntax to run in CommonJS mode, top-level await is not supported
+:::
+
 ## Usage
 ```js
 const tsx = require('tsx/cjs/api')

diff --git a/docs/dev-api/tsx-require.md b/docs/dev-api/tsx-require.md
@@ -8,7 +8,7 @@ Note, the current file path must be passed in as the second argument to resolve
 
 ::: warning Caveats
 
-- `import()` calls in the loaded files are not enhanced.
+- `import()` calls in the loaded files are not enhanced. Use [`tsImport()`](/dev-api/ts-import) instead.
 - Because it compiles ESM syntax to run in CommonJS mode, top-level await is not supported
 :::