Skip to content

docs: clarify "type": "module" requirement for type generation in Next.js projects #13282

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
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: clarify "type": "module" requirement for type generation in Next.js projects #13282

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
14 changes: 14 additions & 0 deletions docs/typescript/generating-types.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,20 @@ payload generate:types

You can run this command whenever you need to regenerate your types, and then you can use these types in your Payload code directly.

### ⚠️ Note for Next.js users

In a default Next.js project (which does **not** include `"type": "module"` in `package.json`), you might encounter an error when running `payload generate:types`.

To fix this, add the following line to your `package.json`:

```json
{
"type": "module"
}
```

> 💡 This enables ECMAScript Modules (ESM) which are required for the type generation script to run correctly.

## Disable declare statement

By default, `generate:types` will add a `declare` statement to your types file, which automatically enables type inference within Payload.
Expand Down