Add JSDoc annotations to public API

[tannerlinsley]

This pull request contains changes generated by Cursor background composer.

 

Summary by CodeRabbit

• New Features

  • Added a new hook to test locations against route definitions and retrieve matched parameters.

• Documentation

  • Enhanced documentation for navigation and route matching APIs with comprehensive usage guidance.

[cursor]

Cursor Agent can help with this pull request. Just @cursor in comments and I'll start working on changes in this branch.
_{Learn more about Cursor Agents}

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The PR introduces a new public useMatchRoute hook in the React Router that returns a matcher function for testing locations against route definitions. It wraps router.matchRoute with configurable options. Both useMatchRoute and useNavigate receive comprehensive JSDoc documentation updates.

Changes

Cohort / File(s)	Summary
New useMatchRoute hook with documentation packages/react-router/src/Matches.tsx	Added public useMatchRoute<TRouter>() hook that returns a matcher function for testing locations against routes; delegates to router.matchRoute with options passthrough (pending, caseSensitive, fuzzy, includeSearch). Added JSDoc documentation for useMatchRoute, useMatches, useParentMatches, and useChildMatches.
useNavigate documentation packages/react-router/src/useNavigate.tsx	Added detailed JSDoc documentation block to the exported useNavigate hook describing purpose, usage guidance, options, and return type. No functional changes.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

The changes involve straightforward documentation additions and a new hook that delegates to existing router functionality without introducing complex control flow. The useMatchRoute implementation is a thin wrapper with clear semantics. Primary review focus: verifying the hook's type parameters and options passthrough are correct.

Possibly related PRs

• Add essential jsdoc to public api #5551: Modifies JSDoc documentation for the useNavigate hook in the same file.

Poem

🐰 A matcher hook hops into town,
Testing routes with nary a frown,
JSDoc comments so clear and bright,
Navigation docs set just right,
Hooks now dance in organized lines! ✨

✨ Finishing touches

• 📝 Generate docstrings

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch cursor/add-jsdoc-annotations-to-public-api-38a6

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7f809a8 and d0b4273.

📒 Files selected for processing (2)

• packages/react-router/src/Matches.tsx (2 hunks)
• packages/react-router/src/useNavigate.tsx (1 hunks)

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[nx-cloud]

View your CI Pipeline Execution ↗ for commit d0b4273

Command	Status	Duration	Result
nx affected --targets=test:eslint,test:unit,tes...	✅ Succeeded	6m 2s	View ↗
nx run-many --target=build --exclude=examples/*...	✅ Succeeded	52s	View ↗

---

☁️ Nx Cloud last updated this comment at 2025-10-21 20:42:07 UTC