Skip to content

Update links to documentation for router utils #12199

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 3 commits into from
Closed

Update links to documentation for router utils #12199

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fb5733a
update links
Johngeorgesample Oct 29, 2024
85dcd72
snip whitespace
Johngeorgesample Oct 29, 2024
ffc9f93
sign contributors.yml
Johngeorgesample Oct 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions contributors.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,6 +131,7 @@
- JesusTheHun
- jimniels
- jmargeta
- johngeorgesample
- johnpangalos
- jonkoops
- jrakotoharisoa
Expand Down
8 changes: 4 additions & 4 deletions packages/router/utils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -504,7 +504,7 @@ export function convertRoutesToDataRoutes(
/**
* Matches the given routes to a location and returns the match data.
*
* @see https://reactrouter.com/utils/match-routes
* @see https://reactrouter.com/en/main/utils/match-routes
*/
export function matchRoutes<
RouteObjectType extends AgnosticRouteObject = AgnosticRouteObject
Expand Down Expand Up @@ -857,7 +857,7 @@ function matchRouteBranch<
/**
* Returns a path with params interpolated.
*
* @see https://reactrouter.com/utils/generate-path
* @see https://reactrouter.com/en/main/utils/generate-path
*/
export function generatePath<Path extends string>(
originalPath: Path,
Expand Down Expand Up @@ -963,7 +963,7 @@ type Mutable<T> = {
* Performs pattern matching on a URL pathname and returns information about
* the match.
*
* @see https://reactrouter.com/utils/match-path
* @see https://reactrouter.com/en/main/utils/match-path
*/
export function matchPath<
ParamKey extends ParamParseKey<Path>,
Expand Down Expand Up @@ -1123,7 +1123,7 @@ export function stripBasename(
/**
* Returns a resolved path object relative to the given pathname.
*
* @see https://reactrouter.com/utils/resolve-path
* @see https://reactrouter.com/en/main/utils/resolve-path
*/
export function resolvePath(to: To, fromPathname = "/"): Path {
let {
Expand Down