Skip to content
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

Jump to bottom

Document generatePath #240

Merged
merged 1 commit into from
May 27, 2024
Merged

Document generatePath #240

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
19 changes: 19 additions & 0 deletions docs/api/utilities.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,3 +50,22 @@ const basePath = '/base';
const { pathname, search } = window.location;
const matchedRoute = matchRoute(routes, pathname, search, basePath);
```

## generatePath

The same as in React Router library, `generatePath` can be used to generate URLs from the routes. Internally the `path-to-regexp` library is used.
It accepts route path with parameters in it, and an object with those parameters values.

```
// Will return /user/1/posts
generatePath("/user/:id/:entity(posts|comments)", {
id: 1,
entity: "posts"
});
```

If provided params and path don’t match, an error will be thrown.
```
// TypeError: Expected "entity" to be defined
generatePath("/user/:id/:entity(posts|comments)", { id: 1 });
```
Loading