import * as mod from "https://dotland.deno.dev/x/oak@v17.1.3/router.ts";

Contains the router of oak. Typical usage is the creation of an application instance, the creation of a router instance, registration of route middleware, registration of router with the application, and then starting to listen for requests.

Example

import { Application } from "jsr:@oak/oak@14/application";
import { Router } from "jsr:@oak/oak@14/router";

const app = new Application();
const router = new Router();
router.get("/", (ctx) => {
  ctx.response.body = "hello world!";
});
app.use(router.routes());
app.use(router.allowedMethods());

app.listen();

Classes

c Layer	An internal class used to group together middleware when using multiple middlewares with a router.
c Router	An interface for registering middleware that will run when certain HTTP methods and paths are requested, as well as provides a way to parameterize parts of the requested path.

Interfaces

I Route	The internal abstraction of a route used by the oak `Router`.
I RouterAllowedMethodsOptions	Options which can be specified when calling the `.allowedMethods()` method on a `Router` instance.
I RouterContext	The context passed router middleware.
I RouterMiddleware	The interface that `Router` middleware should adhere to.
I RouterOptions	Options which can be specified when creating a new instance of a `Router`.
I RouterParamMiddleware	Middleware that will be called by the router when handling a specific parameter, which the middleware will be called when a request matches the route parameter.

Type Aliases

RouteParams

A dynamic type which attempts to determine the route params based on matching the route string.