A simple URL generator in Javascript.
To install the stable version:
npm install --save url-routes-generator
This assumes you are using npm as your package manager.
First, register your routes:
import { uri } from "url-routes-generator";
export const Routes = {
home: params => uri("/")(params),
invoices: params => uri("/invoices")(params),
invoice: (id, params) => uri("/invoices/:id", {id})(params),
sendInvoice: (id, email, params) => uri("/invoices/:id/sendto/:email", {id, email})(params),
about: params => uri("/about")(params)
};Then, you can call the Routes object to generate a valid URL.
Printing routes:
console.log(Routes.home()); // /
console.log(Routes.about()); // /about
console.log(Routes.invoice(23)); // /invoices/23
console.log(Routes.sendInvoice(23, '[email protected]')); // /invoices/23/sendto/[email protected]
console.log(Routes.invoices({orderBy:"date")); // /about?orderBy=date
console.log(Routes.invoice(23, {print:true, page: 2})); // /invoices/23?print=true&page=2Example usage with react-router:
<Link to={Routes.about()}>About us</Link>
<Link to={Routes.invoice(23)}>Invoice</Link>
<Redirect to={Routes.about({source: "dashboard"})}/>If you are using react-router, you need to place the route pattern (/invoices/:id) in the route definition. To get the route pattern, call the route with no params.
Example:
<Switch>
<Route exact path={Routes.invoices()} component={Dashboard}/>
<Route path={Routes.invoice()} component={Invoice}/>
</Switch>Type declarations are included in the package.
Open-sourced software licensed under the MIT license
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent