TanStack / TanStack/router

docs(router): align RouteMatch API reference with the current public contract

Open Beginner friendly
#7,789 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
15.1k
Forks
1.9k
Avg merge
1d 20h
Merged PRs (30d)
143

Description

Goal

Bring the RouteMatch API reference in line with the current public contract.

Scope

  • Remove obsolete showPending and fetchedAt entries from docs/router/api/router/RouteMatchType.md.
  • Add fullPath using its route-specific type, Route['fullPath'].
  • Add index and explain its ordering within the matched route array.
  • Update cause to include 'preload'.
  • Keep internal and lifecycle-specific match state out of the reference, including displayPendingPromise, fetchCount, preload, invalid, headers, and globalNotFound.
  • Review the complete page against packages/router-core/src/Matches.ts so the reference describes the intentional public API.

Related Work

This continues the RouteMatch reference update started in #4894

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

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.

Assessment

Tech stack
typescript
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Clearly specified
Newbie friendliness
78/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.