Skip to main content
Deno 2 is finally here 🎉️
Learn more
Module

x/oak/router.ts>Route

A middleware framework for handling HTTP with Deno, Node, Bun and Cloudflare Workers 🐿️ 🦕
Very Popular
Latest
interface Route
import { type Route } from "https://deno.land/x/oak@v17.1.2/router.ts";

The internal abstraction of a route used by the oak Router.

Type Parameters

R extends string
optional
P extends RouteParams<R> = RouteParams<R>
optional
S extends State = Record<string, any>

Properties

methods: HTTPMethods[]

The HTTP methods that this route handles.

middleware: RouterMiddleware<R, P, S>[]

The middleware that will be applied to this route.

optional
name: string

An optional name for the route.

options: LayerOptions

Options that were used to create the route.

paramNames: (keyof P)[]

The parameters that are identified in the route that will be parsed out on matched requests.

path: string

The path that this route manages.

regexp: RegExp

The regular expression used for matching and parsing parameters for the route.