Repository navigation
docs: annotate route paths and params in examples - #728
Merged
Merged
Conversation
These APIs accept plain strings, so the guides show the PageParams and RouteUrl checks, and AGENTS.md asks examples to type-check. Co-authored-by: Cursor <cursoragent@cursor.com>
yangshun
force-pushed
the
docs/typed-route-examples
branch
from
November 6, 2026 07:57
cb532f1 to
10a9b9c
Compare
Signed-off-by: Christoph Nakazawa <christoph.pojer@gmail.com>
cpojer
added a commit
that referenced
this pull request
Nov 7, 2026
## Summary
`revalidate({ paths })` from `void/isr` now checks its paths against the
app's routes when `routing.typedRoutes` is on, like `Link`, the router
methods, and `c.rewrite()`.
- `RevalidateOptions.paths` is `RouteUrl[]` instead of `string[]`. With
the flag off, `RouteUrl` is `string`, so untyped apps see no change.
- A path TypeScript can't check, such as one from a webhook payload,
needs `as RouteUrl`. The cast turns the check off for that path.
- `routing.prerender` is unchanged. It lives in `void.config.ts`, which
is outside the app's TypeScript project.
## Docs
- `guide/edge/revalidation.md` and `reference/api/resources.md`: drop
the `satisfies RouteUrl[]` workaround (from #728), say the paths are
checked with `routing.typedRoutes`, and explain the `as RouteUrl` escape
hatch. The signature now shows `RouteUrl[]`.
- `guide/type-safety.md`: add `revalidate({ paths })` to "Checked URL
strings" and the `RouteUrl` bullet, and split the "What Gets Checked"
row so `revalidate` and `routing.prerender` are listed separately.
`routing.prerender` keeps its `satisfies RouteUrl[]` guidance, now shown
in a `void.config.ts` example. The existing cast paragraph now says the
cast turns the check off.
- `reference/config.md` (`routing.typedRoutes`): list `revalidate({
paths })` among the checked APIs.
## Tests
- `route-url-builder.test.ts` (typed fixture, through both the generated
and package declarations): known paths, a `` `/users/${id}` `` template
literal, and a `RouteUrl` pass. An unknown path and a plain `string[]`
are `@ts-expect-error`. `string[] as RouteUrl[]` passes. I checked that
the new `@ts-expect-error` lines fail against the old `string[]`
declaration.
- `typed-navigation.typecheck.ts`: with the flag off, a plain `string[]`
and an unknown path still pass.
Verification: the focused test passes, as do `vp run check`, `vp run
test`, and `vp test run` (781 files, 16,156 tests).
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
Co-authored-by: Christoph Nakazawa <cnakazawa@cloudflare.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Motivation
I noticed the docs aren't showing the most type-safe way of using the APIs. Since agents heavily refer to the docs for examples, improving type safety of the docs will help end-users generate more robust code.
Summary
PageParamsandsatisfies RouteUrlin examples forc.redirect(),c.req.param(),revalidate({ paths }), androuting.prerender, which still accept plain strings.AGENTS.md.