RouterMiddleware | /router.ts | oak@v17.1.2

Module

x/oak/router.ts>RouterMiddleware

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 RouterMiddleware

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

The interface that Router middleware should adhere to.

Type Parameters

R extends string

optional

P extends RouteParams<R> = RouteParams<R>

optional

S extends State = Record<string, any>

Call Signatures

(context: RouterContext<R, P, S>, next: () => Promise<unknown>): Promise<unknown> | unknown

Properties

optional

param: keyof P

For route parameter middleware, the param key for this parameter will be set.

optional

router: Router<any>