Skip to content
Source
Sign inSign up
TanStack/router

docs(router): correct ReturnType of `Router.matchRoute` to match the runtime output #3896

MergedRedbird10(GitHub profile, opens in a new tab)merged 1 commit intomain fromrefs/pull/3896/headmerged by SeanCassiere

The .matchRoute method on the Router type page previously stated it returns a RouteMatch object. In reality, it returns only the route match's params.

This update corrects the return type in docs to reflect actual behavior.

Fix #3875

    1. github-actions[bot](GitHub profile, opens in a new tab) added labelsdocumentation

    2. SeanCassiere approved these changes

    3. SeanCassiere changed the title

    4. View your CI Pipeline Execution ↗ for commit 72abfdeaa8b4f182669eb15cdc5a4e508867dcdf.

      CommandStatusDurationResult
      nx run-many --target=build --exclude=examples/*...✅ Succeeded3sView ↗
      nx affected --targets=test:eslint,test:unit,tes...✅ Succeeded<1sView ↗

      ☁️ Nx Cloud last updated this comment at 2025-03-31 22:09:44 UTC

    5. More templates

      @tanstack/arktype-adapter

      npm i https://pkg.pr.new/TanStack/router/@tanstack/arktype-adapter@3896

      @tanstack/create-router

      npm i https://pkg.pr.new/TanStack/router/@tanstack/create-router@3896

      @tanstack/directive-functions-plugin

      npm i https://pkg.pr.new/TanStack/router/@tanstack/directive-functions-plugin@3896

      @tanstack/eslint-plugin-router

      npm i https://pkg.pr.new/TanStack/router/@tanstack/eslint-plugin-router@3896

      @tanstack/create-start

      npm i https://pkg.pr.new/TanStack/router/@tanstack/create-start@3896

      @tanstack/history

      npm i https://pkg.pr.new/TanStack/router/@tanstack/history@3896

      @tanstack/react-router

      npm i https://pkg.pr.new/TanStack/router/@tanstack/react-router@3896

      @tanstack/react-router-devtools

      npm i https://pkg.pr.new/TanStack/router/@tanstack/react-router-devtools@3896

      @tanstack/react-router-with-query

      npm i https://pkg.pr.new/TanStack/router/@tanstack/react-router-with-query@3896

      @tanstack/react-start

      npm i https://pkg.pr.new/TanStack/router/@tanstack/react-start@3896

      @tanstack/react-start-client

      npm i https://pkg.pr.new/TanStack/router/@tanstack/react-start-client@3896

      @tanstack/react-start-config

      npm i https://pkg.pr.new/TanStack/router/@tanstack/react-start-config@3896

      @tanstack/react-start-plugin

      npm i https://pkg.pr.new/TanStack/router/@tanstack/react-start-plugin@3896

      @tanstack/react-start-router-manifest

      npm i https://pkg.pr.new/TanStack/router/@tanstack/react-start-router-manifest@3896

      @tanstack/react-start-server

      npm i https://pkg.pr.new/TanStack/router/@tanstack/react-start-server@3896

      @tanstack/router-cli

      npm i https://pkg.pr.new/TanStack/router/@tanstack/router-cli@3896

      @tanstack/router-core

      npm i https://pkg.pr.new/TanStack/router/@tanstack/router-core@3896

      @tanstack/router-devtools

      npm i https://pkg.pr.new/TanStack/router/@tanstack/router-devtools@3896

      @tanstack/router-devtools-core

      npm i https://pkg.pr.new/TanStack/router/@tanstack/router-devtools-core@3896

      @tanstack/router-generator

      npm i https://pkg.pr.new/TanStack/router/@tanstack/router-generator@3896

      @tanstack/router-plugin

      npm i https://pkg.pr.new/TanStack/router/@tanstack/router-plugin@3896

      @tanstack/router-utils

      npm i https://pkg.pr.new/TanStack/router/@tanstack/router-utils@3896

      @tanstack/router-vite-plugin

      npm i https://pkg.pr.new/TanStack/router/@tanstack/router-vite-plugin@3896

      @tanstack/server-functions-plugin

      npm i https://pkg.pr.new/TanStack/router/@tanstack/server-functions-plugin@3896

      @tanstack/solid-router

      npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-router@3896

      @tanstack/solid-router-devtools

      npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-router-devtools@3896

      @tanstack/solid-start

      npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-start@3896

      @tanstack/solid-start-client

      npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-start-client@3896

      @tanstack/solid-start-config

      npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-start-config@3896

      @tanstack/solid-start-plugin

      npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-start-plugin@3896

      @tanstack/solid-start-router-manifest

      npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-start-router-manifest@3896

      @tanstack/solid-start-server

      npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-start-server@3896

      @tanstack/start

      npm i https://pkg.pr.new/TanStack/router/@tanstack/start@3896

      @tanstack/start-api-routes

      npm i https://pkg.pr.new/TanStack/router/@tanstack/start-api-routes@3896

      @tanstack/start-client-core

      npm i https://pkg.pr.new/TanStack/router/@tanstack/start-client-core@3896

      @tanstack/start-config

      npm i https://pkg.pr.new/TanStack/router/@tanstack/start-config@3896

      @tanstack/start-server-core

      npm i https://pkg.pr.new/TanStack/router/@tanstack/start-server-core@3896

      @tanstack/start-server-functions-client

      npm i https://pkg.pr.new/TanStack/router/@tanstack/start-server-functions-client@3896

      @tanstack/start-server-functions-fetcher

      npm i https://pkg.pr.new/TanStack/router/@tanstack/start-server-functions-fetcher@3896

      @tanstack/start-server-functions-handler

      npm i https://pkg.pr.new/TanStack/router/@tanstack/start-server-functions-handler@3896

      @tanstack/start-server-functions-server

      npm i https://pkg.pr.new/TanStack/router/@tanstack/start-server-functions-server@3896

      @tanstack/start-server-functions-ssr

      npm i https://pkg.pr.new/TanStack/router/@tanstack/start-server-functions-ssr@3896

      @tanstack/valibot-adapter

      npm i https://pkg.pr.new/TanStack/router/@tanstack/valibot-adapter@3896

      @tanstack/virtual-file-routes

      npm i https://pkg.pr.new/TanStack/router/@tanstack/virtual-file-routes@3896

      @tanstack/zod-adapter

      npm i https://pkg.pr.new/TanStack/router/@tanstack/zod-adapter@3896

      commit: 72abfde

    6. SeanCassiere changed the title

    7. SeanCassiere merged this1bbe4a0

    8. SeanCassiere closed this

Sign in to join this conversation.