Class BunWayApp

Hierarchy (View Summary)

Router
- BunWayApp

Constructors

constructor

new BunWayApp(options?: BunWayOptions): BunWayApp
Parameters
- Optionaloptions: BunWayOptions
Returns BunWayApp
Overrides Router.constructor
- Defined in src/core/app.ts:57

Properties

`Protected`_appContext

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

`Protected`children

children: SubRouter[] = []

`Protected`errorHandlers

errorHandlers: ErrorHandler[] = []

`Protected`fastMatcher

fastMatcher: FastMatcher = ...

locals

locals: Record<string, unknown> = {}

`Protected`middlewares

middlewares: Handler[] = []

`Protected`paramHandlers

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

`Protected`routerOptions

routerOptions: RouterOptions

`Protected`routes

routes: RouteDefinition[] = []

`Protected`wsRoutes

wsRoutes: WebSocketRouteDefinition[] = []

Accessors

mountpath

get mountpath(): string
The path pattern(s) on which a sub-app was mounted. Express compat: app.mountpath

Returns string
- Defined in src/core/app.ts:81
set mountpath(value: string): void
Parameters
- value: string
Returns void
- Defined in src/core/app.ts:85

server

get server(): Server<unknown> | null
Returns Server<unknown> | null
- Defined in src/core/app.ts:152

Methods

all

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

close

close(callback?: () => void): Promise<void>
Parameters
- Optionalcallback: () => void
Returns Promise<void>
- Defined in src/core/app.ts:156

delete

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

disable

disable(setting: string): this
Parameters
- setting: string
Returns this
- Defined in src/core/app.ts:120

disabled

disabled(setting: string): boolean
Parameters
- setting: string
Returns boolean
- Defined in src/core/app.ts:129

enable

enable(setting: string): this
Parameters
- setting: string
Returns this
- Defined in src/core/app.ts:115

enabled

enabled(setting: string): boolean
Parameters
- setting: string
Returns boolean
- Defined in src/core/app.ts:125

engine

engine(
    ext: string,
    fn: (
        path: string,
        options: Record<string, unknown>,
        callback: (err: Error | null, html?: string) => void,
    ) => void,
): this
Parameters
- ext: string
- fn: (
      path: string,
      options: Record<string, unknown>,
      callback: (err: Error | null, html?: string) => void,
  ) => void
Returns this
- Defined in src/core/app.ts:133

get

get(setting: string): unknown
Parameters
- setting: string
Returns unknown
Overrides Router.get
- Defined in src/core/app.ts:106
get(path: string | RegExp, ...handlers: Handler[]): this
Parameters
- path: string | RegExp
- ...handlers: Handler[]
Returns this
Overrides Router.get
- Defined in src/core/app.ts:107

`Protected`getChildren

getChildren(): SubRouter[]
Returns SubRouter[]
Inherited from Router.getChildren
- Defined in src/core/router.ts:78

getEngine

getEngine(
    ext: string,
):
    | (
        (
            path: string,
            options: Record<string, unknown>,
            callback: (err: Error | null, html?: string) => void,
        ) => void
    )
    | undefined
Parameters
- ext: string
Returns
    | (
        (
            path: string,
            options: Record<string, unknown>,
            callback: (err: Error | null, html?: string) => void,
        ) => void
    )
    | undefined
- Defined in src/core/app.ts:139

`Protected`getErrorHandlers

getErrorHandlers(): ErrorHandler[]
Returns ErrorHandler[]
Inherited from Router.getErrorHandlers
- Defined in src/core/router.ts:74

getLogger

getLogger(): BunWayLogger
Returns BunWayLogger
- Defined in src/core/app.ts:148

`Protected`getMiddlewares

getMiddlewares(): Handler[]
Returns Handler[]
Inherited from Router.getMiddlewares
- Defined in src/core/router.ts:70

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: '/', ... }, ...]
```
Inherited from Router.getRegisteredRoutes
- Defined in src/core/router.ts:458

`Protected`getRoutes

getRoutes(): RouteDefinition[]
Returns RouteDefinition[]
Inherited from Router.getRoutes
- Defined in src/core/router.ts:66

getSettings

getSettings(): Readonly<AppSettings>
Returns Readonly<AppSettings>
- Defined in src/core/app.ts:144

getWsRoutes

getWsRoutes(): WebSocketRouteDefinition[]
Returns WebSocketRouteDefinition[]
Inherited from Router.getWsRoutes
- Defined in src/core/router.ts:371

group

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

handle

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

`Protected`handleInternal

handleInternal(
    original: Request,
    pathname: string,
    method: string,
    server?: Server<unknown>,
    parentParams?: Record<string, string>,
): 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>
Returns Promise<Response>
Inherited from Router.handleInternal
- Defined in src/core/router.ts:611

head

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

listen

listen(port?: number, callback?: () => void): Server<unknown>
Parameters
- Optionalport: number
- Optionalcallback: () => void
Returns Server<unknown>
- Defined in src/core/app.ts:166
listen(options?: ListenOptions, callback?: () => void): Server<unknown>
Parameters
- Optionaloptions: ListenOptions
- Optionalcallback: () => void
Returns Server<unknown>
- Defined in src/core/app.ts:167

matchWebSocketRoute

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

options

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

param

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

patch

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

path

path(): string
Returns the canonical path of the app, based on mountpath. Express compat: app.path()

Returns string
- Defined in src/core/app.ts:93

post

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

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
```
Inherited from Router.printRoutes
- Defined in src/core/router.ts:414

put

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

route

route(path: string): Route
Parameters
- path: string
Returns Route
Inherited from Router.route
- Defined in src/core/router.ts:273

set

set(setting: string, value: unknown): this
Parameters
- setting: string
- value: unknown
Returns this
- Defined in src/core/app.ts:101

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
Inherited from Router.setAppContext
- Defined in src/core/router.ts:62

use

use(handler: Handler): this
Parameters
- handler: Handler
Returns this
Inherited from Router.use
- Defined in src/core/router.ts:277
use(paths: string[], router: Router): this
Parameters
- paths: string[]
- router: Router
Returns this
Inherited from Router.use
- Defined in src/core/router.ts:278
use(paths: string[], ...handlers: Handler[]): this
Parameters
- paths: string[]
- ...handlers: Handler[]
Returns this
Inherited from Router.use
- Defined in src/core/router.ts:279
use(path: string, router: Router): this
Parameters
- path: string
- router: Router
Returns this
Inherited from Router.use
- Defined in src/core/router.ts:280
use(path: string, ...handlers: Handler[]): this
Parameters
- path: string
- ...handlers: Handler[]
Returns this
Inherited from Router.use
- Defined in src/core/router.ts:281

ws

ws(path: string, handlers: WebSocketHandlers): this
Parameters
- path: string
- handlers: WebSocketHandlers
Returns this
Inherited from Router.ws
- Defined in src/core/router.ts:350
ws(path: string, ...args: [...Handler[], WebSocketHandlers]): this
Parameters
- path: string
- ...args: [...Handler[], WebSocketHandlers]
Returns this
Inherited from Router.ws
- Defined in src/core/router.ts:351

Class BunWayApp

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns BunWayApp

Properties

Protected_appContext

Protectedchildren

ProtectederrorHandlers

ProtectedfastMatcher

locals

Protectedmiddlewares

ProtectedparamHandlers

ProtectedrouterOptions

Protectedroutes

ProtectedwsRoutes

Accessors

mountpath

Returns string

Parameters

Returns void

server

Returns Server<unknown> | null

Methods

all

Parameters

Returns this

close

Parameters

Returns Promise<void>

delete

Parameters

Returns this

disable

Parameters

Returns this

disabled

Parameters

Returns boolean

enable

Parameters

Returns this

enabled

Parameters

Returns boolean

engine

Parameters

Returns this

get

Parameters

Returns unknown

Parameters

Returns this

ProtectedgetChildren

Returns SubRouter[]

getEngine

Parameters

Returns | ( ( path: string, options: Record<string, unknown>, callback: (err: Error | null, html?: string) => void, ) => void ) | undefined

ProtectedgetErrorHandlers

Returns ErrorHandler[]

getLogger

Returns BunWayLogger

ProtectedgetMiddlewares

Returns Handler[]

getRegisteredRoutes

Parameters

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

Example

ProtectedgetRoutes

Returns RouteDefinition[]

getSettings

Returns Readonly<AppSettings>

getWsRoutes

Returns WebSocketRouteDefinition[]

`Protected`_appContext

`Protected`children

`Protected`errorHandlers

`Protected`fastMatcher

`Protected`middlewares

`Protected`paramHandlers

`Protected`routerOptions

`Protected`routes

`Protected`wsRoutes

`Protected`getChildren

Returns
| (
(
path: string,
options: Record<string, unknown>,
callback: (err: Error | null, html?: string) => void,
) => void
)
| undefined

`Protected`getErrorHandlers

`Protected`getMiddlewares

`Protected`getRoutes

`Protected`handleInternal