@orkestrel/router

A typed request router for the @orkestrel line — the first @orkestrel package to ship both server and browser environments alongside its shared core. Built to sit beside @orkestrel/contract (validation) and @orkestrel/emitter (observable lifecycle), reusing both as it takes shape.

Install

npm install @orkestrel/router

Requirements

• Node.js >= 24
• ESM-only (no CommonJS build)
• Server and browser environments both supported

Usage

import { createDispatcher, createRouter } from '@orkestrel/router'

const router = createRouter<{ readonly page: string }>()
router.add({ path: '/users/:id', meta: { page: 'profile' } })
router.match('/users/7') // { path: '/users/:id', params: { id: '7' }, meta: { page: 'profile' } }

const dispatcher = createDispatcher<{ readonly userId: string }>({
	routes: [
		{
			method: 'GET',
			path: '/users/:id',
			handler: (_request, context) => Response.json(context.params),
		},
	],
})
const response = await dispatcher.handle(new Request('http://x/users/7'), { userId: 'me' })

Router is the shared registry-and-match engine — literal-over-param-over-wildcard precedence, trailing-slash folding, and tolerant percent-decoding — that both Dispatcher (fetch-standard, method-dimensioned) and the browser Navigator compose. Path params are inferred at the type level from the literal pattern via PathParams, and route() pins a RouteInput's path so literal inference survives across call sites. The ./browser entry adds createNavigator for headless History/hash navigation; the ./server entry adds buildRequest / sendResponse / createListener for node:http.

Guide

For the full surface — the core Router, the Dispatcher, the browser Navigator, and the node:http server adapter — see guides/src/router.md.

Package

Published as three environment-scoped entry points per the exports field in package.json: a shared core, ./browser, and ./server.

License

MIT © Orkestrel — see LICENSE.