docs(router): align RouteMatch API reference with the current public contract
Maintainers usually reply within 1 day
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 78/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Quiet
- Tech stack
- typescript
- Domain
- documentation
Research direction
Start with docs/router/api/router/RouteMatchType.md and compare it against packages/router-core/src/Matches.ts, using the public contract described in the issue as the guide. Remove obsolete and internal fields, add the specified public fields and cause value, and review the complete page for accuracy. Done means the reference matches the intentional public RouteMatch API without lifecycle-only state.
Written by the indexing model from the issue text.
Description
Goal
Bring the RouteMatch API reference in line with the current public contract.
Scope
- Remove obsolete
showPendingandfetchedAtentries fromdocs/router/api/router/RouteMatchType.md. - Add
fullPathusing its route-specific type,Route['fullPath']. - Add
indexand explain its ordering within the matched route array. - Update
causeto include'preload'. - Keep internal and lifecycle-specific match state out of the reference, including
displayPendingPromise,fetchCount,preload,invalid,headers, andglobalNotFound. - Review the complete page against
packages/router-core/src/Matches.tsso the reference describes the intentional public API.
Related Work
This continues the RouteMatch reference update started in #4894
- Dominant language
- TypeScript
- Stars
- 15.1k
- Forks
- 1.9k
- Avg merge
- 1d 17h
- Merged PRs (30d)
- 134
Getting set up
Starts the project's dev container in your browser, under your own GitHub account.
- No Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from TanStack/router
-
Inline scripts are duplicated after hydration when the CSP nonce is sent in a headerPossibly taken @gabriel-le claimed this 6 days ago. Open
Difficulty 1/5 Under an hour Newbie friendliness 90/100
Maintainers usually reply within 1 day
-
start-plugin-core: sitemap lastmod and pages.json lastBuilt are stamped with the build's wall clock (no SOURCE_DATE_EPOCH support)Possibly taken @treadnot claimed this 8 days ago. Open
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
Maintainers usually reply within 1 day
-
Empty .ts route file is scaffolded with JSX, breaking all route generationPossibly taken @nathan-logan claimed this 12 days ago. Open
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
Maintainers usually reply within 1 day
-
information needed
Difficulty 1/5 Under an hour Newbie friendliness 90/100
TanStack/router#8464 · 2 comments ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
TanStack/router#8407 · 1 reaction ·
Maintainers usually reply within 1 day
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Maintainers usually reply within 1 day
-
bug:new
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
callstackincubator/simlock#350 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
openwatersio/maritime-zones#33 ·
Maintainers usually reply within 1 day
-
Booking email verification fails for plus aliases with impersonation protection enabledPossibly taken @kankadev claimed this today. Open
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
calcom/cal.diy#30293 · 1 comment ·
Maintainers usually reply within 5 days
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
AOSSIE-Org/DebateAI#611 ·
Maintainers usually reply within 3 days