docs: improve JSDocs for metadata and <Link>

[leerob]

Improving your in-editor DX 😄

[ijjk]

Failing test suites

Commit: 9de9c46

pnpm test-start-turbo test/e2e/app-dir/rewrite-headers/rewrite-headers.test.ts (turbopack)

• rewrite-headers > middleware rewrite external Prefetch RSC (/hello/vercel) > should have the expected headers
• rewrite-headers > middleware rewrite external RSC (/hello/vercel) > should have the expected headers

Expand output

● rewrite-headers › middleware rewrite external RSC (/hello/vercel) › should have the expected headers

expect(received).toEqual(expected) // deep equality

- Expected  - 1
+ Received  + 1

  Object {
-   "x-nextjs-rewritten-path": null,
+   "x-nextjs-rewritten-path": "/home",
    "x-nextjs-rewritten-query": null,
  }

  404 |         })
  405 |
> 406 |         expect(headers).toEqual(expected)
      |                         ^
  407 |       })
  408 |     }
  409 |   )

  at Object.toEqual (e2e/app-dir/rewrite-headers/rewrite-headers.test.ts:406:25)

● rewrite-headers › middleware rewrite external Prefetch RSC (/hello/vercel) › should have the expected headers

expect(received).toEqual(expected) // deep equality

- Expected  - 1
+ Received  + 1

  Object {
-   "x-nextjs-rewritten-path": null,
+   "x-nextjs-rewritten-path": "/home",
    "x-nextjs-rewritten-query": null,
  }

  404 |         })
  405 |
> 406 |         expect(headers).toEqual(expected)
      |                         ^
  407 |       })
  408 |     }
  409 |   )

  at Object.toEqual (e2e/app-dir/rewrite-headers/rewrite-headers.test.ts:406:25)

Read more about building and testing Next.js in contributing.md.

[ijjk]

Stats from current PR

Default Build (Increase detected ⚠️)

General Overall increase ⚠️

	vercel/next.js canary	vercel/next.js jsdocs	Change
buildDuration	18.6s	16.8s	N/A
buildDurationCached	16s	13.6s	N/A
nodeModulesSize	393 MB	393 MB	⚠️ +57.9 kB
nextStartRea..uration (ms)	449ms	440ms	N/A

Client Bundles (main, webpack)

	vercel/next.js canary	vercel/next.js jsdocs	Change
5306-HASH.js gzip	54.3 kB	54.3 kB	N/A
8276.HASH.js gzip	169 B	168 B	N/A
8377-HASH.js gzip	5.46 kB	5.46 kB	N/A
bccd1874-HASH.js gzip	53 kB	53 kB	✓
framework-HASH.js gzip	57.5 kB	57.5 kB	N/A
main-app-HASH.js gzip	245 B	246 B	N/A
main-HASH.js gzip	34.6 kB	34.5 kB	N/A
webpack-HASH.js gzip	1.71 kB	1.71 kB	N/A
Overall change	53 kB	53 kB	✓

Legacy Client Bundles (polyfills)

	vercel/next.js canary	vercel/next.js jsdocs	Change
polyfills-HASH.js gzip	39.4 kB	39.4 kB	✓
Overall change	39.4 kB	39.4 kB	✓

Client Pages

	vercel/next.js canary	vercel/next.js jsdocs	Change
_app-HASH.js gzip	193 B	193 B	✓
_error-HASH.js gzip	193 B	193 B	✓
amp-HASH.js gzip	512 B	510 B	N/A
css-HASH.js gzip	343 B	342 B	N/A
dynamic-HASH.js gzip	1.84 kB	1.84 kB	✓
edge-ssr-HASH.js gzip	265 B	265 B	✓
head-HASH.js gzip	363 B	362 B	N/A
hooks-HASH.js gzip	393 B	392 B	N/A
image-HASH.js gzip	4.59 kB	4.58 kB	N/A
index-HASH.js gzip	268 B	268 B	✓
link-HASH.js gzip	2.35 kB	2.35 kB	N/A
routerDirect..HASH.js gzip	328 B	328 B	✓
script-HASH.js gzip	397 B	397 B	✓
withRouter-HASH.js gzip	323 B	326 B	N/A
1afbb74e6ecf..834.css gzip	106 B	106 B	✓
Overall change	3.59 kB	3.59 kB	✓

Client Build Manifests

	vercel/next.js canary	vercel/next.js jsdocs	Change
_buildManifest.js gzip	748 B	747 B	N/A
Overall change	0 B	0 B	✓

Rendered Page Sizes

	vercel/next.js canary	vercel/next.js jsdocs	Change
index.html gzip	522 B	523 B	N/A
link.html gzip	538 B	538 B	✓
withRouter.html gzip	518 B	520 B	N/A
Overall change	538 B	538 B	✓

Edge SSR bundle Size

	vercel/next.js canary	vercel/next.js jsdocs	Change
edge-ssr.js gzip	130 kB	130 kB	N/A
page.js gzip	211 kB	211 kB	N/A
Overall change	0 B	0 B	✓

Middleware size

	vercel/next.js canary	vercel/next.js jsdocs	Change
middleware-b..fest.js gzip	675 B	670 B	N/A
middleware-r..fest.js gzip	155 B	156 B	N/A
middleware.js gzip	31.3 kB	31.3 kB	N/A
edge-runtime..pack.js gzip	844 B	844 B	✓
Overall change	844 B	844 B	✓

Next Runtimes

	vercel/next.js canary	vercel/next.js jsdocs	Change
app-page-exp...dev.js gzip	394 kB	394 kB	✓
app-page-exp..prod.js gzip	132 kB	132 kB	✓
app-page-tur..prod.js gzip	145 kB	145 kB	✓
app-page-tur..prod.js gzip	141 kB	141 kB	✓
app-page.run...dev.js gzip	381 kB	381 kB	✓
app-page.run..prod.js gzip	129 kB	129 kB	✓
app-route-ex...dev.js gzip	39.3 kB	39.3 kB	✓
app-route-ex..prod.js gzip	25.6 kB	25.6 kB	✓
app-route-tu..prod.js gzip	25.6 kB	25.6 kB	✓
app-route-tu..prod.js gzip	25.4 kB	25.4 kB	✓
app-route.ru...dev.js gzip	40.9 kB	40.9 kB	✓
app-route.ru..prod.js gzip	25.4 kB	25.4 kB	✓
dist_client_...dev.js gzip	356 B	356 B	✓
dist_client_...dev.js gzip	349 B	349 B	✓
pages-api-tu..prod.js gzip	9.69 kB	9.69 kB	✓
pages-api.ru...dev.js gzip	11.8 kB	11.8 kB	✓
pages-api.ru..prod.js gzip	9.68 kB	9.68 kB	✓
pages-turbo...prod.js gzip	21.9 kB	21.9 kB	✓
pages.runtim...dev.js gzip	31.5 kB	31.5 kB	✓
pages.runtim..prod.js gzip	21.9 kB	21.9 kB	✓
server.runti..prod.js gzip	60.7 kB	60.7 kB	✓
Overall change	1.67 MB	1.67 MB	✓

build cache Overall increase ⚠️

	vercel/next.js canary	vercel/next.js jsdocs	Change
0.pack gzip	2.11 MB	2.11 MB	⚠️ +1.05 kB
index.pack gzip	75.1 kB	75.4 kB	⚠️ +231 B
Overall change	2.19 MB	2.19 MB	⚠️ +1.28 kB

Diff details

Diff for main-HASH.js

Diff too large to display

Commit: c113556