powahroot1.0.0 • Public • Published
Client and server-side routing micro frameworks
Powahroot is a pair of micro routing frameworks, presented as an ES6 module:
- The first is for client-side single-page web applications
- The other is for handling server-side Node.js requests
It's based on
rill (see the npm package bearing the name), but stripped down and simplified.
Install powahroot as a dependency with npm:
npm install --save powahroot
If your build process supports tree-shaking, only the router(s?) you need will be included in the final output of your build - as powahroot uses ES6 modules.
Powahroot supports multiple syntax bells and whistles when defining routes. These are documented below:
||Regular route. Matches exactly what it says on the tin.|
||Special key(word?) that matches any route. Must be present on its own without any other characters.|
||Parameters. Match values an pull them into an object automatically. Does not like forward slashes in parameter values.|
||Parameter values with forward slashes. If you want to use parameters, but need values to be able to contain forward slashes
Initialise a new router like this:
;// ....const router =// Options object. Default settings:verbose: false // Whether to be verbose in console.log() messageslisten_pushstate: true // Whether to react to browser pushstate events (excluding those generated by powahroot itself, because that would cause an infinite loop :P);
The server router works slightly differently, to account for the different environment it's designed for. Here's how to use it:
;// ....const router = ;routerrouter;// .....
context argument there is of type
RouterContext. Check out the API reference (link below) to learn about the other useful properties it has.
API docs are generated automatically. View them here:
Everything in this repository except the logo is licenced under the _Mozilla Public License 2.0.
The logo itself is © Copyright Starbeamrainbowlabs 2019. All rights reserved - though you may use it when linking to this project (or to advertise usage in a 'powered by' logo).