Skip to content

docs: fix generateImageMetadata example to use normal params object #85658

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

Merged
merged 4 commits into from
Nov 3, 2025
Merged

docs: fix generateImageMetadata example to use normal params object #85658

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
fc172cc
Clarify params handling in generateImageMetadata example for Next.js 16
marjan-ahmed Nov 1, 2025
dccc1d0
docs(next-16): clarify async behavior in image metadata examples
marjan-ahmed Nov 1, 2025
5503c5f
docs: generateImageMetadata feedback
icyJoseph Nov 3, 2025
aa31e95
Merge branch 'canary' into fix/generateImageMetadata-docs
icyJoseph Nov 3, 2025
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
5 changes: 2 additions & 3 deletions docs/01-app/02-guides/upgrading/version-16.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -322,12 +322,11 @@ export default function Image({ params, id }) {
}
```

Starting with **Next.js 16**, to align with the [Async Request APIs](#async-request-apis-breaking-change) change, these are also asynchronous.
Starting with **Next.js 16**, to align with the [Async Request APIs](#async-request-apis-breaking-change) change, the image generating function now receives `params` and `id` as promises. The `generateImageMetadata` function continues to receive synchronous `params`.

```js filename="app/shop/[slug]/opengraph-image.js"
// Next.js 16 - asynchronous params access
export async function generateImageMetadata({ params }) {
const { slug } = await params
const { slug } = params
return [{ id: '1' }, { id: '2' }]
}

Expand Down
Loading