router

A miniaturized (and fast af) router for the edge, and everywhere else.

import { Router, text, json } from "@johno/router";

const router = new Router();

router
  .get("/", (req) => text("Hello world!"))
  .get("/hello/:name", (req, env, ctx, routeInfo) => {
    json({ name: routeInfo.params.name });
  });

router.handle(request, env, ctx);

Features

• Simple, declarative API
• Built for the edge
• Standards-based (Request/Response/URL)
• Zero dependencies
• Tiny footprint
• ESM-only
• Written in TypeScript

Motivation

@johno/router is built for edge environments including Cloudflare Workers, Lambda, Netlify Functions, Next.js, etc. What makes @johno/router interesting is what it doesn't do.

@johno/router does not:

• Monkey patch the global Request and Response objects
• Route match with regex, it uses a custom parser
• Implement a bespoke handler API
• Use middleware, we recommend using lib functions
• Minify or obfuscate code (readable and debuggable output)

Handler API

@johno/router uses a simple handler API that is compatible with the Request and Response objects. It augments edge function handlers with an additional argument, routeInfo. This means you can drop in @johno/router to any serverless function environment and you will work with their existing APIs.

Installation

Use your favorite package manager to install @johno/router:

npm install @johno/router

# pnpm add @johno/router
# yarn add @johno/router
# bun add @johno/router

Usage

If you've used a router before, @johno/router will feel familiar. To define a set of routes you:

• Instantiate a router
• Add routes for given paths and HTTP methods
• Pass each route a handler function
• Call handle with the request and its environment

import { Router, text } from "@johno/router";

const router = new Router();

router.get("/", (req, res) => {
  text("Hello world!");
});

router.get("/hello/:name", (req, res, routeInfo) => {
  text(`Hello ${routeInfo.params.name}!`);
});

router.handle(request, env, ctx);

Using with Cloudflare Workers

@johno/router is designed to work seamlessly with Cloudflare Workers. The handle method accepts the Request, Env, and Context objects which you can leverage in your handlers.

import { Router, text, json } from "@johno/router";

const router = new Router();

export default {
  async fetch(
    request: Request,
    env: Env,
    ctx: ExecutionContext
  ): Promise<Response> {
    return router
      .post("/hello", () => text("Hello world!"))
      .post("/world", () => json({ hello: "world" }))
      .handle(request, env, ctx);
  },
};

Code of Conduct

By participating in our community and interacting with this repository, you agree to abide by our code of conduct.

Development

To learn about how to contribute to this project, please read the contributing guide.

License

MIT

Built by johno