@parisholley/road-runner
v1.1.8
Published
The fastest path resolver for URL routing on modern Node.JS
Downloads
41
Readme
Road Runner Router
A router for when latency is Wile E. Coyote :) Inspired by
julienschmidt/httprouter
and partly derived from
steambap/koa-tree-router.
Why is it fast?
- Params are detected and provided as objects, but no regex or value casting, strings only
- Case sensitive (use .toLowerCase() when inserting/retrieving if you want case-insensitivity)
- Limited validation (assuming you are going to pass in valid paths and HTTP methods)
- No URL parsing, most environments provide some type of req.path functionality
Getting Started
The following snippet is the basic setup of the router, remember, it is up to you to tie into your favorite HTTP library and execute the handler code and return a response (if any):
import {RoadRunner} from "@parisholley/road-runner";
const router = RoadRunner();
router.addRoute('GET', '/path', () => {});
// handler === {value: "() => {}", params: {}}
const result = router.lookupRoute('GET', '/path');
result.value();
router.addRoute('GET', '/path/:nested', () => {});
// handler === {value: "() => {}", params: {nested: 'foobar'}}
const result2 = router.lookupRoute('GET', '/path/foobar');
result2.value();
Supported Path Syntax
- /foo
- /:foo
- /*
- /foo/:bar
- /foo/*
- /foo/:bar/baz
- /foo/*/baz
- /foo/:bar/baz/:bum
- /foo/*/baz/*
- /foo/:bar/baz/*
- /foo/*/baz/:bum
Unsupported Path Syntax
- /foo/:bar-:baz
- /foo/bar:baz
- /foo/bar-*
API Versioning
This library categorizes paths into buckets
, which ultimately are up
to you to decide the format of. Most developers will likely pass in the
HTTP Method
when adding routes, but you can choose any string value
you would like. In the case of switching behavior based on an API
version provided in the header, you could do something like this:
import {RoadRunner} from "@parisholley/road-runner";
const router = RoadRunner();
router.addRoute(`POST:2.1`, '/document/:id', () => {});
function doLookup(headers:Record<string,string>){
const result = router.lookupRoute(`POST:${headers['version']}`, '/document/:id');
result.value();
}