Class Router

Hierarchy (View Summary)

Router
- BunWayApp

Constructors

constructor

new Router(opts?: RouterOptions): Router
Parameters
- opts: RouterOptions = {}
Returns Router
- Defined in src/core/router.ts:72

Properties

`Protected`_appContext

_appContext: { setApp: (req: BunRequest, res: BunResponse) => void } | null = null

`Protected`children

children: SubRouter[] = []

`Protected`errorHandlers

errorHandlers: ErrorHandler[] = []

`Protected`fastMatcher

fastMatcher: FastMatcher = ...

`Protected`middlewares

middlewares: Handler[] = []

`Protected`paramHandlers

paramHandlers: Map<string, ParamHandler[]> = ...

`Protected`prefixMiddlewares

prefixMiddlewares: { handlers: Handler[]; prefix: string }[] = []

`Protected`routerOptions

routerOptions: RouterOptions

`Protected`routes

routes: RouteDefinition[] = []

`Protected`wsRoutes

wsRoutes: WebSocketRouteDefinition[] = []

Methods

all

all(path: string | RegExp, ...handlers: Handler[]): this
Parameters
- path: string | RegExp
- ...handlers: Handler[]
Returns this
- Defined in src/core/router.ts:395

delete

delete(path: string | RegExp, ...handlers: Handler[]): this
Parameters
- path: string | RegExp
- ...handlers: Handler[]
Returns this
- Defined in src/core/router.ts:355

get

get(path: string | RegExp, ...handlers: Handler[]): this
Parameters
- path: string | RegExp
- ...handlers: Handler[]
Returns this
- Defined in src/core/router.ts:325

`Protected`getChildren

getChildren(): SubRouter[]
Returns SubRouter[]
- Defined in src/core/router.ts:96

`Protected`getErrorHandlers

getErrorHandlers(): ErrorHandler[]
Returns ErrorHandler[]
- Defined in src/core/router.ts:92

`Protected`getMiddlewares

getMiddlewares(): Handler[]
Returns Handler[]
- Defined in src/core/router.ts:88

getRegisteredRoutes

getRegisteredRoutes(
prefix?: string,
): { fullPath: string; method: string; path: string }[]
Get all registered routes as an array (for programmatic access).
Parameters
- prefix: string = ""
Returns { fullPath: string; method: string; path: string }[]
Example
```
const routes = app.getRegisteredRoutes();
// [{ method: 'GET', path: '/', ... }, ...]
```
- Defined in src/core/router.ts:597

`Protected`getRoutes

getRoutes(): RouteDefinition[]
Returns RouteDefinition[]
- Defined in src/core/router.ts:84

getWsRoutes

getWsRoutes(): WebSocketRouteDefinition[]
Returns WebSocketRouteDefinition[]
- Defined in src/core/router.ts:510

group

group(
    prefix: string,
    callbackOrOptions?: GroupCallback | GroupOptions,
    callback?: GroupCallback,
): this
Parameters
- prefix: string
- OptionalcallbackOrOptions: GroupCallback | GroupOptions
- Optionalcallback: GroupCallback
Returns this
- Defined in src/core/router.ts:466

handle

handle(original: Request, server?: Server<unknown>): Promise<Response>
Parameters
- original: Request
- Optionalserver: Server<unknown>
Returns Promise<Response>
- Defined in src/core/router.ts:626

`Protected`handleInternal

handleInternal(
    original: Request,
    pathname: string,
    method: string,
    server?: Server<unknown>,
    parentParams?: Record<string, string>,
    baseUrl?: string,
    errorBubble?: (
        err: unknown,
        req: BunRequest,
        res: BunResponse,
    ) => Promise<Response>,
): Promise<Response>
Internal handle method for child router delegation - avoids creating new Request/URL objects
Parameters
- original: Request
- pathname: string
- method: string
- Optionalserver: Server<unknown>
- OptionalparentParams: Record<string, string>
- OptionalbaseUrl: string
- OptionalerrorBubble: (err: unknown, req: BunRequest, res: BunResponse) => Promise<Response>
Returns Promise<Response>
- Defined in src/core/router.ts:697

head

head(path: string | RegExp, ...handlers: Handler[]): this
Parameters
- path: string | RegExp
- ...handlers: Handler[]
Returns this
- Defined in src/core/router.ts:385

matchWebSocketRoute

matchWebSocketRoute(
    pathname: string,
):
    | { params: Record<string, string>; route: WebSocketRouteDefinition }
    | null
Parameters
- pathname: string
Returns { params: Record<string, string>; route: WebSocketRouteDefinition } | null
- Defined in src/core/router.ts:514

options

options(path: string | RegExp, ...handlers: Handler[]): this
Parameters
- path: string | RegExp
- ...handlers: Handler[]
Returns this
- Defined in src/core/router.ts:375

param

param(name: string, handler: ParamHandler): this
Parameters
- name: string
- handler: ParamHandler
Returns this
- Defined in src/core/router.ts:100

patch

patch(path: string | RegExp, ...handlers: Handler[]): this
Parameters
- path: string | RegExp
- ...handlers: Handler[]
Returns this
- Defined in src/core/router.ts:365

post

post(path: string | RegExp, ...handlers: Handler[]): this
Parameters
- path: string | RegExp
- ...handlers: Handler[]
Returns this
- Defined in src/core/router.ts:335

printRoutes

printRoutes(prefix?: string): void
Print all registered routes for debugging. Useful during development to see what routes are available.
Parameters
- prefix: string = ""
Returns void
Example
```
app.printRoutes();
// Output:
// GET     /
// GET     /users
// POST    /users
// GET     /users/:id
// WS      /chat
```
- Defined in src/core/router.ts:553

put

put(path: string | RegExp, ...handlers: Handler[]): this
Parameters
- path: string | RegExp
- ...handlers: Handler[]
Returns this
- Defined in src/core/router.ts:345

route

route(path: string): Route
Parameters
- path: string
Returns Route
- Defined in src/core/router.ts:412

setAppContext

setAppContext(
context: { setApp: (req: BunRequest, res: BunResponse) => void },
): void
Set the app context for direct injection (used by BunWayApp)
Parameters
- context: { setApp: (req: BunRequest, res: BunResponse) => void }
Returns void
- Defined in src/core/router.ts:80

use

use(handler: Handler): this
Parameters
- handler: Handler
Returns this
- Defined in src/core/router.ts:416
use(paths: string[], router: Router): this
Parameters
- paths: string[]
- router: Router
Returns this
- Defined in src/core/router.ts:417
use(paths: string[], ...handlers: Handler[]): this
Parameters
- paths: string[]
- ...handlers: Handler[]
Returns this
- Defined in src/core/router.ts:418
use(path: string, router: Router): this
Parameters
- path: string
- router: Router
Returns this
- Defined in src/core/router.ts:419
use(path: string, ...handlers: Handler[]): this
Parameters
- path: string
- ...handlers: Handler[]
Returns this
- Defined in src/core/router.ts:420

ws

ws(path: string, handlers: WebSocketHandlers): this
Parameters
- path: string
- handlers: WebSocketHandlers
Returns this
- Defined in src/core/router.ts:489
ws(path: string, ...args: [...Handler[], WebSocketHandlers]): this
Parameters
- path: string
- ...args: [...Handler[], WebSocketHandlers]
Returns this
- Defined in src/core/router.ts:490

Class Router

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Router

Properties

Protected_appContext

Protectedchildren

ProtectederrorHandlers

ProtectedfastMatcher

Protectedmiddlewares

ProtectedparamHandlers

ProtectedprefixMiddlewares

ProtectedrouterOptions

Protectedroutes

ProtectedwsRoutes

Methods

all

Parameters

Returns this

delete

Parameters

Returns this

get

Parameters

Returns this

ProtectedgetChildren

Returns SubRouter[]

ProtectedgetErrorHandlers

Returns ErrorHandler[]

ProtectedgetMiddlewares

Returns Handler[]

getRegisteredRoutes

Parameters

Returns { fullPath: string; method: string; path: string }[]

Example

ProtectedgetRoutes

Returns RouteDefinition[]

getWsRoutes

Returns WebSocketRouteDefinition[]

group

Parameters

Returns this

handle

Parameters

Returns Promise<Response>

ProtectedhandleInternal

Parameters

Returns Promise<Response>

head

Parameters

Returns this

matchWebSocketRoute

Parameters

Returns { params: Record<string, string>; route: WebSocketRouteDefinition } | null

options

Parameters

Returns this

param

Parameters

Returns this

patch

Parameters

Returns this

post

Parameters

Returns this

printRoutes

Parameters

Returns void

Example

put

Parameters

Returns this

route

`Protected`_appContext

`Protected`children

`Protected`errorHandlers

`Protected`fastMatcher

`Protected`middlewares

`Protected`paramHandlers

`Protected`prefixMiddlewares

`Protected`routerOptions

`Protected`routes

`Protected`wsRoutes

`Protected`getChildren

`Protected`getErrorHandlers

`Protected`getMiddlewares

`Protected`getRoutes

`Protected`handleInternal