Class Bearn

BearnApp

Hierarchy (View Summary)

Router
- Bearn

Index

Constructors

constructor

new Bearn(options?: AppOptions): Bearn
Constructs a new Bearn application instance.
Parameters
- Optionaloptions: AppOptions = {}
  The options for the Bearn application.
Returns Bearn
Overrides Router.constructor
- Defined in src/core/app.ts:68

Properties

`Readonly`basePrefix

basePrefix: undefined | string

An optional prefix used when the router is mounted without a specific path.

`Readonly`description

description: undefined | string

An optional description for the router, useful for documentation or logging.

`Readonly`name

name: undefined | string

An optional name for the router, useful for identification.

Methods

close

close(callback?: (err?: Error) => void): void
Function
Stops the server if running.
Parameters
- Optionalcallback: (err?: Error) => void
  The callback function to call when the server stops.
Returns void
- Defined in src/core/app.ts:198

delete

delete<Path extends string, TResponse extends JsonValue = JsonValue>(
    path: Path,
    ...handlers:
        | [...Handler[], PathHandler<Path, TResponse>]
        | [...Handler[], PathHandler<Path, TResponse>, RouteSchema],
): void
Registers a DELETE route with optional middleware and schema.
Type Parameters
- Path extends string
- TResponse extends JsonValue = JsonValue
Parameters
- path: Path
  The path for the route.
- ...handlers:
  | [...Handler[], PathHandler<Path, TResponse>]
  | [...Handler[], PathHandler<Path, TResponse>, RouteSchema]
  The handlers and optional schema for the route.
Returns void
Inherited from Router.delete
- Defined in src/routing/routerCore.ts:174

get

get<Path extends string, TResponse extends JsonValue = JsonValue>(
    path: Path,
    ...handlers:
        | [...Handler[], PathHandler<Path, TResponse>]
        | [...Handler[], PathHandler<Path, TResponse>, RouteSchema],
): void
Registers a GET route with optional middleware and schema.
Type Parameters
- Path extends string
- TResponse extends JsonValue = JsonValue
Parameters
- path: Path
  The path for the route.
- ...handlers:
  | [...Handler[], PathHandler<Path, TResponse>]
  | [...Handler[], PathHandler<Path, TResponse>, RouteSchema]
  The handlers and optional schema for the route.
Returns void
Inherited from Router.get
- Defined in src/routing/routerCore.ts:121

getRoutes

getRoutes(): Route[]
Function
Retrieves a list of all registered routes, including those from mounted routers.

Returns Route[]
An array of all routes.
Inherited from Router.getRoutes
- Defined in src/routing/routerCore.ts:397

handle

handle(req: Request, res: Response): Promise<void>
Function
Handles an incoming request by executing middleware and matching routes.
Parameters
- req: Request
  The incoming request object.
- res: Response
  The response object to send data back to the client.
Returns Promise<void>
Inherited from Router.handle
- Defined in src/routing/routerCore.ts:289

head

head<Path extends string, TResponse extends JsonValue = JsonValue>(
    path: Path,
    ...handlers:
        | [...Handler[], PathHandler<Path, TResponse>]
        | [...Handler[], PathHandler<Path, TResponse>, RouteSchema],
): void
Registers a HEAD route with optional middleware and schema.
Type Parameters
- Path extends string
- TResponse extends JsonValue = JsonValue
Parameters
- path: Path
  The path for the route.
- ...handlers:
  | [...Handler[], PathHandler<Path, TResponse>]
  | [...Handler[], PathHandler<Path, TResponse>, RouteSchema]
  The handlers and optional schema for the route.
Returns void
Inherited from Router.head
- Defined in src/routing/routerCore.ts:210

middleware

middleware(handler?: Handler): void
An alias for the use method to register middleware.
Parameters
- Optionalhandler: Handler
  The handler to register.
Returns void
Inherited from Router.middleware
- Defined in src/routing/routerCore.ts:99
middleware(path: string, handler: Handler): void
An alias for the use method to register middleware.
Parameters
- path: string
- handler: Handler
  The handler to register.
Returns void
Inherited from Router.middleware
- Defined in src/routing/routerCore.ts:100

mount

mount(router?: Router): void
An alias for the use method to mount a router.
Parameters
- Optionalrouter: Router
  The router to mount.
Returns void
Inherited from Router.mount
- Defined in src/routing/routerCore.ts:110
mount(path: string, router: Router): void
An alias for the use method to mount a router.
Parameters
- path: string
- router: Router
  The router to mount.
Returns void
Inherited from Router.mount
- Defined in src/routing/routerCore.ts:111

onError

onError(handler: ErrorHandler): void
Function
Registers a global error handler invoked on uncaught route/middleware errors.
Parameters
- handler: ErrorHandler
  The error handler function to register.
Returns void
- Defined in src/core/app.ts:207

options

options<Path extends string, TResponse extends JsonValue = JsonValue>(
    path: Path,
    ...handlers:
        | [...Handler[], PathHandler<Path, TResponse>]
        | [...Handler[], PathHandler<Path, TResponse>, RouteSchema],
): void
Registers an OPTIONS route with optional middleware and schema.
Type Parameters
- Path extends string
- TResponse extends JsonValue = JsonValue
Parameters
- path: Path
  The path for the route.
- ...handlers:
  | [...Handler[], PathHandler<Path, TResponse>]
  | [...Handler[], PathHandler<Path, TResponse>, RouteSchema]
  The handlers and optional schema for the route.
Returns void
Inherited from Router.options
- Defined in src/routing/routerCore.ts:228

patch

patch<Path extends string, TResponse extends JsonValue = JsonValue>(
    path: Path,
    ...handlers:
        | [...Handler[], PathHandler<Path, TResponse>]
        | [...Handler[], PathHandler<Path, TResponse>, RouteSchema],
): void
Registers a PATCH route with optional middleware and schema.
Type Parameters
- Path extends string
- TResponse extends JsonValue = JsonValue
Parameters
- path: Path
  The path for the route.
- ...handlers:
  | [...Handler[], PathHandler<Path, TResponse>]
  | [...Handler[], PathHandler<Path, TResponse>, RouteSchema]
  The handlers and optional schema for the route.
Returns void
Inherited from Router.patch
- Defined in src/routing/routerCore.ts:192

post

post<Path extends string, TResponse extends JsonValue = JsonValue>(
    path: Path,
    ...handlers:
        | [...Handler[], PathHandler<Path, TResponse>]
        | [...Handler[], PathHandler<Path, TResponse>, RouteSchema],
): void
Registers a POST route with optional middleware and schema.
Type Parameters
- Path extends string
- TResponse extends JsonValue = JsonValue
Parameters
- path: Path
  The path for the route.
- ...handlers:
  | [...Handler[], PathHandler<Path, TResponse>]
  | [...Handler[], PathHandler<Path, TResponse>, RouteSchema]
  The handlers and optional schema for the route.
Returns void
Inherited from Router.post
- Defined in src/routing/routerCore.ts:139

put

put<Path extends string, TResponse extends JsonValue = JsonValue>(
    path: Path,
    ...handlers:
        | [...Handler[], PathHandler<Path, TResponse>]
        | [...Handler[], PathHandler<Path, TResponse>, RouteSchema],
): void
Registers a PUT route with optional middleware and schema.
Type Parameters
- Path extends string
- TResponse extends JsonValue = JsonValue
Parameters
- path: Path
  The path for the route.
- ...handlers:
  | [...Handler[], PathHandler<Path, TResponse>]
  | [...Handler[], PathHandler<Path, TResponse>, RouteSchema]
  The handlers and optional schema for the route.
Returns void
Inherited from Router.put
- Defined in src/routing/routerCore.ts:156

registerDecoratedControllers

registerDecoratedControllers(): void
Function
Registers any controllers discovered via decorators. Typically invoked automatically on first request.

Returns void
- Defined in src/core/app.ts:253

start

start(callback?: (info: ListenInfo) => void): Server
Function
Starts the HTTP server and begins handling requests.
Parameters
- Optionalcallback: (info: ListenInfo) => void
  The callback function to call when the server starts.
Returns Server
The underlying Node Server instance.
- Defined in src/core/app.ts:86

use

use(handler?: Handler): void
Registers a middleware or router.
Parameters
- Optionalhandler: Handler
  The middleware handler or router.
Returns void
Overrides Router.use
- Defined in src/core/app.ts:56
use(path: string, handler: Handler): void
Registers a middleware or router.
Parameters
- path: string
- handler: Handler
  The middleware handler or router.
Returns void
Overrides Router.use
- Defined in src/core/app.ts:57
use(path: string, router: Router): void
Registers a middleware or router.
Parameters
- path: string
- router: Router
Returns void
Overrides Router.use
- Defined in src/core/app.ts:58
use(router: Router): void
Registers a middleware or router.
Parameters
- router: Router
Returns void
Overrides Router.use
- Defined in src/core/app.ts:59

Class Bearn

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Bearn

Properties

ReadonlybasePrefix

Readonlydescription

Readonlyname

Methods

close

Parameters

Returns void

delete

Type Parameters

Parameters

Returns void

get

Type Parameters

Parameters

Returns void

getRoutes

Returns Route[]

handle

Parameters

Returns Promise<void>

head

Type Parameters

Parameters

Returns void

middleware

Parameters

Returns void

Parameters

Returns void

mount

Parameters

Returns void

Parameters

Returns void

onError

Parameters

Returns void

options

Type Parameters

Parameters

Returns void

patch

Type Parameters

Parameters

Returns void

post

Type Parameters

Parameters

Returns void

put

Type Parameters

Parameters

Returns void

registerDecoratedControllers

Returns void

start

Parameters

Returns Server

use

Parameters

Returns void

Parameters

Returns void

Parameters

Returns void

Parameters

Returns void

Settings

On This Page

`Readonly`basePrefix

`Readonly`description

`Readonly`name