Skip to content

docs: add missing package.json "type": "module" step to TypeScript in… #2464

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jnzlab wants to merge 1 commit into
base: main
Choose a base branch
from
+19 −0
Open

docs: add missing package.json "type": "module" step to TypeScript in… #2464

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions src/content/docs/en/5x/starter/installing.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,25 @@ for example `@types/cors` alongside `cors`.

</Alert>

Since the `tsconfig.json` below uses `"module": "nodenext"`, TypeScript determines whether each
file is treated as an ES Module or CommonJS based on the `"type"` field in your `package.json`.
Add `"type": "module"` to your `package.json` so that ES Module `import`/`export` syntax is
recognized:

```json title="package.json"
{
"type": "module"
}
```

<Alert type="warning">

Without `"type": "module"`, TypeScript will treat `.ts` files as CommonJS and report an error like
`ECMAScript imports and exports cannot be written in a CommonJS file under 'verbatimModuleSyntax'`
when you use `import`/`export` syntax.

</Alert>

Add a `tsconfig.json`. These options mirror how Node.js runs TypeScript and make the compiler reject
non-erasable syntax (such as `enum`s, namespaces, and parameter properties) that Node cannot strip:

Expand Down
Loading