RouterContext | /router.ts | oak@v17.1.3

Module

x/oak/router.ts>RouterContext

A middleware framework for handling HTTP with Deno, Node, Bun and Cloudflare Workers 🐿️ 🦕

oakserver/oak

Very Popular

Latest

examples middleware utils

mod.ts (default module)

application.ts

Application

ApplicationCloseEvent

ApplicationErrorEvent

ApplicationListenEvent

http_server_native_request.ts

http_server_native.ts

MiddlewareOrMiddlewareObject

RouterAllowedMethodsOptions

RouterContext

RouterMiddleware

RouterOptions

RouterParamMiddleware

UpgradeWebSocketOptions

Data

Key

ServeHandler

UpgradeWebSocketFn

interface RouterContext

implements Context<S>

import { type RouterContext } from "https://deno.land/x/oak@v17.1.3/router.ts";

The context passed router middleware.

Type Parameters

R extends string

optional

P extends RouteParams<R> = RouteParams<R>

optional

S extends State = Record<string, any>

Properties

captures: string[]

When matching the route, an array of the capturing groups from the regular expression.

optional

matched: Layer<R, P, S>[]

The routes that were matched for this request.

params: P

Any parameters parsed from the route when matched.

router: Router

A reference to the router instance.

optional

routeName: string

If the matched route has a name, the matched route name is provided here.

optional

routerPath: string

Overrides the matched path for future route middleware, when a routerPath option is not defined on the Router options.