Skip to content

Commit

Permalink
Document generatePath (#240)
Browse files Browse the repository at this point in the history
  • Loading branch information
DmitryGonchar authored May 27, 2024
1 parent aecbe73 commit 51cfc2a
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions docs/api/utilities.md
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 });
```

0 comments on commit 51cfc2a

Please sign in to comment.