Skip to content

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

Description

@LadyBluenotes

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    Fields

    No fields configured for Task.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions