Routing

ovr’s router offers efficient and fast route matching, supporting static paths, parameters, and wildcards. Utilizing a trie structure ensures performance does not degrade as you add more routes.

The router is forked and adapted from memoirist and @medley/router.

Parameters

Create a parameter for a route using the colon before a path segment.

The pattern /api/:id creates a params object on the Context with a property of id containing the actual path segment requested.

app.post("/api/:id", (c) => {
	// matches "/api/123"
	c.params; // { id: "123" }
});

Wildcard

Use an asterisk * to match all remaining segments in the route.

app.get("/files/*", (c) => {
	c.params["*"]; // matched wildcard path (ex: "images/logo.png")
});

Prioritization

Routes are prioritized in this order:

Static > Parametric > Wildcard

Given three routes are added in any order:

trie.add(new Route("/hello/world", "store"));
trie.add(new Route("/hello/:name", "store"));
trie.add(new Route("/hello/*", "store"));

More specific matches are prioritized. The following pathnames would match the corresponding patterns:

Create your own router

App is built using the Trie and Route classes. You won’t need to access these if you are using App, but you can build your own router using the them.

import { Route, Trie } from "ovr";

// specify the type of the store in the generic
const trie = new Trie<string>();
const route = new Route("/hello/:name", "store");

trie.add(route);

const match = trie.find("/hello/world"); // { route, params: { name: "world" } }