router-segments
Router with segments
### Why another router ?
This router take full advantages of segments, building a tree of regexp to avoid having 500 regexp calls for one route.
### How to use
router-segments uses [path-to-regexp](https://www.npmjs.com/package/path-to-regexp) for matching the route paths,
also used by [expressjs](https://expressjs.com/en/guide/routing.html), [koa-router](https://www.npmjs.com/package/koa-router)
and many other routers.
```js
import { createRouterBuilder } from "router-segments";
const builder = createRouterBuilder();
builder.add("/", ref);
builder.addSegment("/post", (segmentBuilder) => {
segmentBuilder.add("/:id/:slug", ref, "/post/view");
segmentBuilder.defaultRoute(ref, "/post");
});
export default builder.createRouter();
```
#### Url Generator
[path-to-regexp documentation](https://www.npmjs.com/package/path-to-regexp#compile-reverse-path-to-regexp)
```js
router.toPath("/post/view", { id: "001", slug: "a-slug" });
// /post/001/a-slug
```
## Localized routes
```js
import { createRouterBuilder } from "router-segments";
const builder = createRouterBuilder(["en", "fr"]);
builder.add("/", ref);
builder.addLocalizedSegment(
{
en: "/my-blog",
fr: "/mon-blog",
},
(segmentBuilder) => {
segmentBuilder.addLocalized(
{
en: "/post/:id",
fr: "/billet/:id",
},
ref,
"/my-blog/post",
);
segmentBuilder.defaultRoute(ref, "/my-blog");
},
);
export const router = builder.createRouter();
```
## API
https://christophehurpeau.github.io/router-segments/