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

x/oak/router.ts>Router#use

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

Register middleware to be used on every matched route.

Type Parameters

optional
P extends RouteParams<string> = RouteParams<string>
optional
S extends State = RS

Parameters

middleware: RouterMiddleware<string, P, S>
...middlewares: RouterMiddleware<string, P, S>[]

Returns

Router<S extends RS ? S : (S & RS)>

Register middleware to be used on every route that matches the supplied path.

Type Parameters

R extends string
optional
P extends RouteParams<R> = RouteParams<R>
optional
S extends State = RS

Parameters

path: R
middleware: RouterMiddleware<R, P, S>
...middlewares: RouterMiddleware<R, P, S>[]

Returns

Router<S extends RS ? S : (S & RS)>

Register middleware to be used on every route that matches the supplied path with explicit path parameters.

Type Parameters

P extends RouteParams<string>
optional
S extends State = RS

Parameters

path: string
middleware: RouterMiddleware<string, P, S>
...middlewares: RouterMiddleware<string, P, S>[]

Returns

Router<S extends RS ? S : (S & RS)>

Type Parameters

optional
P extends RouteParams<string> = RouteParams<string>
optional
S extends State = RS

Parameters

path: string[]
middleware: RouterMiddleware<string, P, S>
...middlewares: RouterMiddleware<string, P, S>[]

Returns

Router<S extends RS ? S : (S & RS)>