Class Router

BunWay router implementation.

Usage mirrors Express:

const router = new Router();
router.use(cors());
router.get("/health", (ctx) => ctx.res.text("OK"));
router.post("/users", async (ctx) => ctx.res.created(await ctx.req.parseBody()));

Internally the router still works with Request/Response, which means handlers can choose to return a native Response or use ctx.res helpers. Middleware-supplied extras (CORS headers, etc.) are merged in the finalizer so behaviour stays consistent regardless of handler style.

Hierarchy (view full)

Constructors

constructor

Properties

autoBodyParser bodyParserConfig children middlewares routes

Methods

add configureBodyParser delete get getBodyParserConfig handle options patch pathToRegex post put setBodyParser use

Constructors

constructor

Properties

Private autoBodyParser

autoBodyParser: Handler

Private bodyParserConfig

bodyParserConfig: ResolvedBodyParserOptions

Private children

children: SubRouter[] = []

Private middlewares

middlewares: Handler[] = []

Private routes

routes: Route[] = []

Methods

Private add

configureBodyParser

delete

get

getBodyParserConfig

  • getBodyParserConfig(): ResolvedBodyParserOptions

  • Snapshot of the current resolved parser configuration.

    Returns ResolvedBodyParserOptions

handle

  • handle(req): Promise<Response>

  • Parameters

    • req: Request

    Returns Promise<Response>

options

patch

Private pathToRegex

  • pathToRegex(path): {
        keys: string[];
        regex: RegExp;
    }

  • Parameters

    • path: string

    Returns {
        keys: string[];
        regex: RegExp;
    }

    • keys: string[]
    • regex: RegExp

post

put

setBodyParser

use

Settings

Member Visibility

Theme

On This Page

constructorautoBodyParserbodyParserConfigchildrenmiddlewaresroutesaddconfigureBodyParserdeletegetgetBodyParserConfighandleoptionspatchpathToRegexpostputsetBodyParseruse