Class FrameworkApp

The application

Hierarchy (View Summary)

BaseApp
- FrameworkApp

Index

Constructors

constructor

new FrameworkApp(options?: Options): FrameworkApp
Parameters
- Optionaloptions: Options
Returns FrameworkApp
Inherited from BaseApp.constructor
- Defined in baseApp.ts:82

Properties

`Protected`__app

__app: Application

`Protected`__router

__router: IRouter

Accessors

_app

get _app(): Application
Express Application

Returns Application
Inherited from BaseApp._app
- Defined in baseApp.ts:55

_router

get _router(): IRouter
Main router

Returns IRouter
Inherited from BaseApp._router
- Defined in baseApp.ts:62

building

get building(): boolean
Returns boolean
Inherited from BaseApp.building
- Defined in baseApp.ts:66

built

get built(): boolean
Returns boolean
Inherited from BaseApp.built
- Defined in baseApp.ts:70

server

get server(): undefined | Server<typeof IncomingMessage, typeof ServerResponse>
Returns undefined | Server<typeof IncomingMessage, typeof ServerResponse>
Inherited from BaseApp.server
- Defined in baseApp.ts:78

Methods

addFrameworkOptions

addFrameworkOptions(options: FrameworkOptions): this
Parameters
- options: FrameworkOptions
Returns this
Inherited from BaseApp.addFrameworkOptions
- Defined in baseApp.ts:146

addOptions

addOptions(options: Options): this
Parameters
- options: Options
  Options to concatenate with current options.
Returns this
Overrides BaseApp.addOptions
- Defined in app.ts:19

addRouters

addRouters(routers: IRouter | IRouter[]): this
Parameters
- routers: IRouter | IRouter[]
Returns this
Overrides BaseApp.addRouters
- Defined in app.ts:24

all

all<
 Route extends string,
 P = RouteParameters<Route>,
 ResBody = any,
 ReqBody = any,
 ReqQuery = ParsedQs,
 Locals extends Record<string, any> = Record<string, any>,
 MetaResType = any,
>(
 path: RouteSettings<
 Route,
 P,
 ResBody,
 ReqBody,
 ReqQuery,
 Locals,
 MetaResType,
 >,
 ...handlers: RequestHandler<
 P,
 ResBody,
 ReqBody,
 ReqQuery,
 Locals,
 MetaResType,
 >[],
): this
Type Parameters
- Route extends string
- P = RouteParameters<Route>
- ResBody = any
- ReqBody = any
- ReqQuery = ParsedQs
- Locals extends Record<string, any> = Record<string, any>
- MetaResType = any
Parameters
- path: RouteSettings<Route, P, ResBody, ReqBody, ReqQuery, Locals, MetaResType>
- ...handlers: RequestHandler<P, ResBody, ReqBody, ReqQuery, Locals, MetaResType>[]
Returns this
- Defined in app.ts:64
all<
 Path extends string,
 P = RouteParameters<Path>,
 ResBody = any,
 ReqBody = any,
 ReqQuery = ParsedQs,
 Locals extends Record<string, any> = Record<string, any>,
 MetaResType = any,
>(
 path: RouteSettingsParams<
 Path,
 P,
 ResBody,
 ReqBody,
 ReqQuery,
 Locals,
 MetaResType,
 >,
 ...handlers: RequestHandlerParams<
 P,
 ResBody,
 ReqBody,
 ReqQuery,
 Locals,
 MetaResType,
 >[],
): this
Type Parameters
- Path extends string
- P = RouteParameters<Path>
- ResBody = any
- ReqBody = any
- ReqQuery = ParsedQs
- Locals extends Record<string, any> = Record<string, any>
- MetaResType = any
Parameters
- path: RouteSettingsParams<Path, P, ResBody, ReqBody, ReqQuery, Locals, MetaResType>
- ...handlers: RequestHandlerParams<P, ResBody, ReqBody, ReqQuery, Locals, MetaResType>[]
Returns this
- Defined in app.ts:80
all = Record<string, any>,
 MetaResType = any,
>(
 path: RouteSettings<
 PathParams,
 P,
 ResBody,
 ReqBody,
 ReqQuery,
 Locals,
 MetaResType,
 >,
 ...handlers: RequestHandler<
 P,
 ResBody,
 ReqBody,
 ReqQuery,
 Locals,
 MetaResType,
 >[],
): this
Type Parameters
- P = ParamsDictionary
- ResBody = any
- ReqBody = any
- ReqQuery = ParsedQs
- Locals extends Record<string, any> = Record<string, any>
- MetaResType = any
Parameters
- path: RouteSettings<PathParams, P, ResBody, ReqBody, ReqQuery, Locals, MetaResType>
- ...handlers: RequestHandler<P, ResBody, ReqBody, ReqQuery, Locals, MetaResType>[]
Returns this
- Defined in app.ts:96
all = Record<string, any>,
 MetaResType = any,
>(
 path: RouteSettingsParams<
 PathParams,
 P,
 ResBody,
 ReqBody,
 ReqQuery,
 Locals,
 MetaResType,
 >,
 ...handlers: RequestHandlerParams<
 P,
 ResBody,
 ReqBody,
 ReqQuery,
 Locals,
 MetaResType,
 >[],
): this
Type Parameters
- P = ParamsDictionary
- ResBody = any
- ReqBody = any
- ReqQuery = ParsedQs
- Locals extends Record<string, any> = Record<string, any>
- MetaResType = any
Parameters
- path: RouteSettingsParams<
 PathParams,
 P,
 ResBody,
 ReqBody,
 ReqQuery,
 Locals,
 MetaResType,
 >
- ...handlers: RequestHandlerParams<P, ResBody, ReqBody, ReqQuery, Locals, MetaResType>[]
Returns this
- Defined in app.ts:111
all<
 Route extends string,
 P = RouteParameters<Route>,
 ResBody = any,
 ReqBody = any,
 ReqQuery = ParsedQs,
 Locals extends Record<string, any> = Record<string, any>,
>(
 path: Route,
 ...handlers: RequestHandler<P, ResBody, ReqBody, ReqQuery, Locals, any>[],
): this
Type Parameters
- Route extends string
- P = RouteParameters<Route>
- ResBody = any
- ReqBody = any
- ReqQuery = ParsedQs
- Locals extends Record<string, any> = Record<string, any>
Parameters
- path: Route
- ...handlers: RequestHandler<P, ResBody, ReqBody, ReqQuery, Locals, any>[]
Returns this
- Defined in app.ts:126
all<
 Path extends string,
 P = RouteParameters<Path>,
 ResBody = any,
 ReqBody = any,
 ReqQuery = ParsedQs,
 Locals extends Record<string, any> = Record<string, any>,
>(
 path: Path,
 ...handlers: RequestHandlerParams<P, ResBody, ReqBody, ReqQuery, Locals>[],
): this
Type Parameters
- Path extends string
- P = RouteParameters<Path>
- ResBody = any
- ReqBody = any
- ReqQuery = ParsedQs
- Locals extends Record<string, any> = Record<string, any>
Parameters
- path: Path
- ...handlers: RequestHandlerParams<P, ResBody, ReqBody, ReqQuery, Locals>[]
Returns this
- Defined in app.ts:140
all = Record<string, any>,
>(
 path: PathParams,
 ...handlers: RequestHandler<P, ResBody, ReqBody, ReqQuery, Locals, any>[],
): this
Type Parameters
- P = ParamsDictionary
- ResBody = any
- ReqBody = any
- ReqQuery = ParsedQs
- Locals extends Record<string, any> = Record<string, any>
Parameters
- path: PathParams
- ...handlers: RequestHandler<P, ResBody, ReqBody, ReqQuery, Locals, any>[]
Returns this
- Defined in app.ts:154
all = Record<string, any>,
>(
 path: PathParams,
 ...handlers: RequestHandlerParams<P, ResBody, ReqBody, ReqQuery, Locals>[],
): this
Type Parameters
- P = ParamsDictionary
- ResBody = any
- ReqBody = any
- ReqQuery = ParsedQs
- Locals extends Record<string, any> = Record<string, any>
Parameters
- path: PathParams
- ...handlers: RequestHandlerParams<P, ResBody, ReqBody, ReqQuery, Locals>[]
Returns this
- Defined in app.ts:167
all(path: PathParams, subApplication: Application): this
Parameters
- path: PathParams
- subApplication: Application
Returns this
- Defined in app.ts:180

build

build<
 T extends
 ServerOptions<typeof IncomingMessage, typeof ServerResponse> = ServerOptions<
 typeof IncomingMessage,
 typeof ServerResponse,
 >,
>(
 options?: null | T,
 mod?: {
 createServer(
 requestListener?: RequestListener<
 typeof IncomingMessage,
 typeof ServerResponse,
 >,
 ): Server;
 createServer(
 options: T,
 requestListener?: RequestListener<
 typeof IncomingMessage,
 typeof ServerResponse,
 >,
 ): Server;
 },
): Server
Type Parameters
- T extends ServerOptions<typeof IncomingMessage, typeof ServerResponse> = ServerOptions<typeof IncomingMessage, typeof ServerResponse>
Parameters
- Optionaloptions: null | T
- Optionalmod: {
 createServer(
 requestListener?: RequestListener<
 typeof IncomingMessage,
 typeof ServerResponse,
 >,
 ): Server;
 createServer(
 options: T,
 requestListener?: RequestListener<
 typeof IncomingMessage,
 typeof ServerResponse,
 >,
 ): Server;
 }
 Module that will create the server (e.g.: require('https'))
Returns Server
Example
```
const https = require('https');
const server = app.build(HTTPS_SERVER_OPTIONS, https);
server.listen(PORT);
```
Inherited from BaseApp.build
- Defined in baseApp.ts:222

delete

delete<
 Route extends string,
 P = RouteParameters<Route>,
 ResBody = any,
 ReqBody = any,
 ReqQuery = ParsedQs,
 Locals extends Record<string, any> = Record<string, any>,
 MetaResType = any,
>(
 path: RouteSettings<
 Route,
 P,
 ResBody,
 ReqBody,
 ReqQuery,
 Locals,
 MetaResType,
 >,
 ...handlers: RequestHandler<
 P,
 ResBody,
 ReqBody,
 ReqQuery,
 Locals,
 MetaResType,
 >[],
): this
Type Parameters
- Route extends string
- P = RouteParameters<Route>
- ResBody = any
- ReqBody = any
- ReqQuery = ParsedQs
- Locals extends Record<string, any> = Record<string, any>
- MetaResType = any
Parameters
- path: RouteSettings<Route, P, ResBody, ReqBody, ReqQuery, Locals, MetaResType>
- ...handlers: RequestHandler<P, ResBody, ReqBody, ReqQuery, Locals, MetaResType>[]
Returns this
- Defined in app.ts:567
delete<
 Path extends string,
 P = RouteParameters<Path>,
 ResBody = any,
 ReqBody = any,
 ReqQuery = ParsedQs,
 Locals extends Record<string, any> = Record<string, any>,
 MetaResType = any,
>(
 path: RouteSettingsParams<
 Path,
 P,
 ResBody,
 ReqBody,
 ReqQuery,
 Locals,
 MetaResType,
 >,
 ...handlers: RequestHandlerParams<
 P,
 ResBody,
 ReqBody,
 ReqQuery,
 Locals,
 MetaResType,
 >[],
): this
Type Parameters
- Path extends string
- P = RouteParameters<Path>
- ResBody = any
- ReqBody = any
- ReqQuery = ParsedQs
- Locals extends Record<string, any> = Record<string, any>
- MetaResType = any
Parameters
- path: RouteSettingsParams<Path, P, ResBody, ReqBody, ReqQuery, Locals, MetaResType>
- ...handlers: RequestHandlerParams<P, ResBody, ReqBody, ReqQuery, Locals, MetaResType>[]
Returns this
- Defined in app.ts:583
delete = Record<string, any>,
 MetaResType = any,
>(
 path: RouteSettings<
 PathParams,
 P,
 ResBody,
 ReqBody,
 ReqQuery,
 Locals,
 MetaResType,
 >,
 ...handlers: RequestHandler<
 P,
 ResBody,
 ReqBody,
 ReqQuery,
 Locals,
 MetaResType,
 >[],
): this
Type Parameters
- P = ParamsDictionary
- ResBody = any
- ReqBody = any
- ReqQuery = ParsedQs
- Locals extends Record<string, any> = Record<string, any>
- MetaResType = any
Parameters
- path: RouteSettings<PathParams, P, ResBody, ReqBody, ReqQuery, Locals, MetaResType>
- ...handlers: RequestHandler<P, ResBody, ReqBody, ReqQuery, Locals, MetaResType>[]
Returns this
- Defined in app.ts:599
delete = Record<string, any>,
 MetaResType = any,
>(
 path: RouteSettingsParams<
 PathParams,
 P,
 ResBody,
 ReqBody,
 ReqQuery,
 Locals,
 MetaResType,
 >,
 ...handlers: RequestHandlerParams<
 P,
 ResBody,
 ReqBody,
 ReqQuery,
 Locals,
 MetaResType,
 >[],
): this
Type Parameters
- P = ParamsDictionary
- ResBody = any
- ReqBody = any
- ReqQuery = ParsedQs
- Locals extends Record<string, any> = Record<string, any>
- MetaResType = any
Parameters
- path: RouteSettingsParams<
 PathParams,
 P,
 ResBody,
 ReqBody,
 ReqQuery,
 Locals,
 MetaResType,
 >
- ...handlers: RequestHandlerParams<P, ResBody, ReqBody, ReqQuery, Locals, MetaResType>[]
Returns this
- Defined in app.ts:614
delete<
 Route extends string,
 P = RouteParameters<Route>,
 ResBody = any,
 ReqBody = any,
 ReqQuery = ParsedQs,
 Locals extends Record<string, any> = Record<string, any>,
>(
 path: Route,
 ...handlers: RequestHandler<P, ResBody, ReqBody, ReqQuery, Locals, any>[],
): this
Type Parameters
- Route extends string
- P = RouteParameters<Route>
- ResBody = any
- ReqBody = any
- ReqQuery = ParsedQs
- Locals extends Record<string, any> = Record<string, any>
Parameters
- path: Route
- ...handlers: RequestHandler<P, ResBody, ReqBody, ReqQuery, Locals, any>[]
Returns this
- Defined in app.ts:629
delete<
 Path extends string,
 P = RouteParameters<Path>,
 ResBody = any,
 ReqBody = any,
 ReqQuery = ParsedQs,
 Locals extends Record<string, any> = Record<string, any>,
>(
 path: Path,
 ...handlers: RequestHandlerParams<P, ResBody, ReqBody, ReqQuery, Locals>[],
): this
Type Parameters
- Path extends string
- P = RouteParameters<Path>
- ResBody = any
- ReqBody = any
- ReqQuery = ParsedQs
- Locals extends Record<string, any> = Record<string, any>
Parameters
- path: Path
- ...handlers: RequestHandlerParams<P, ResBody, ReqBody, ReqQuery, Locals>[]
Returns this
- Defined in app.ts:643
delete = Record<string, any>,
>(
 path: PathParams,
 ...handlers: RequestHandler<P, ResBody, ReqBody, ReqQuery, Locals, any>[],
): this
Type Parameters
- P = ParamsDictionary
- ResBody = any
- ReqBody = any
- ReqQuery = ParsedQs
- Locals extends Record<string, any> = Record<string, any>
Parameters
- path: PathParams
- ...handlers: RequestHandler<P, ResBody, ReqBody, ReqQuery, Locals, any>[]
Returns this
- Defined in app.ts:657
delete = Record<string, any>,
>(
 path: PathParams,
 ...handlers: RequestHandlerParams<P, ResBody, ReqBody, ReqQuery, Locals>[],
): this
Type Parameters
- P = ParamsDictionary
- ResBody = any
- ReqBody = any
- ReqQuery = ParsedQs
- Locals extends Record<string, any> = Record<string, any>
Parameters
- path: PathParams
- ...handlers: RequestHandlerParams<P, ResBody, ReqBody, ReqQuery, Locals>[]
Returns this
- Defined in app.ts:670
delete(path: PathParams, subApplication: Application): this
Parameters
- path: PathParams
- subApplication: Application
Returns this
- Defined in app.ts:683

disable

disable(setting: string): this
Parameters
- setting: string
Returns this
Overrides BaseApp.disable
- Defined in app.ts:29

disabled

disabled(setting: string): boolean
Parameters
- setting: string
Returns boolean
Inherited from BaseApp.disabled
- Defined in baseApp.ts:342

enable

enable(setting: string): this
Parameters
- setting: string
Returns this
Overrides BaseApp.enable
- Defined in app.ts:34

enabled

enabled(setting: string): boolean
Parameters
- setting: string
Returns boolean
Inherited from BaseApp.enabled
- Defined in baseApp.ts:351

engine

engine(
    ext: string,
    fn: (
        path: string,
        options: object,
        callback: (e: any, rendered?: string) => void,
    ) => void,
): this
Parameters
- ext: string
- fn: (
      path: string,
      options: object,
      callback: (e: any, rendered?: string) => void,
  ) => void
Returns this
Inherited from BaseApp.engine
- Defined in baseApp.ts:366

get

get(setting: string): any
Parameters
- setting: string
Returns any
Overrides BaseApp.get
- Defined in app.ts:189
get<
 Route extends string,
 P = RouteParameters<Route>,
 ResBody = any,
 ReqBody = any,
 ReqQuery = ParsedQs,
 Locals extends Record<string, any> = Record<string, any>,
 MetaResType = any,
>(
 path: RouteSettings<
 Route,
 P,
 ResBody,
 ReqBody,
 ReqQuery,
 Locals,
 MetaResType,
 >,
 ...handlers: RequestHandler<
 P,
 ResBody,
 ReqBody,
 ReqQuery,
 Locals,
 MetaResType,
 >[],
): this
Type Parameters
- Route extends string
- P = RouteParameters<Route>
- ResBody = any
- ReqBody = any
- ReqQuery = ParsedQs
- Locals extends Record<string, any> = Record<string, any>
- MetaResType = any
Parameters
- path: RouteSettings<Route, P, ResBody, ReqBody, ReqQuery, Locals, MetaResType>
- ...handlers: RequestHandler<P, ResBody, ReqBody, ReqQuery, Locals, MetaResType>[]
Returns this
Overrides BaseApp.get
- Defined in app.ts:190
get<
 Path extends string,
 P = RouteParameters<Path>,
 ResBody = any,
 ReqBody = any,
 ReqQuery = ParsedQs,
 Locals extends Record<string, any> = Record<string, any>,
 MetaResType = any,
>(
 path: RouteSettingsParams<
 Path,
 P,
 ResBody,
 ReqBody,
 ReqQuery,
 Locals,
 MetaResType,
 >,
 ...handlers: RequestHandlerParams<
 P,
 ResBody,
 ReqBody,
 ReqQuery,
 Locals,
 MetaResType,
 >[],
): this
Type Parameters
- Path extends string
- P = RouteParameters<Path>
- ResBody = any
- ReqBody = any
- ReqQuery = ParsedQs
- Locals extends Record<string, any> = Record<string, any>
- MetaResType = any
Parameters
- path: RouteSettingsParams<Path, P, ResBody, ReqBody, ReqQuery, Locals, MetaResType>
- ...handlers: RequestHandlerParams<P, ResBody, ReqBody, ReqQuery, Locals, MetaResType>[]
Returns this
Overrides BaseApp.get
- Defined in app.ts:206
get = Record<string, any>,
 MetaResType = any,
>(
 path: RouteSettings<
 PathParams,
 P,
 ResBody,
 ReqBody,
 ReqQuery,
 Locals,
 MetaResType,
 >,
 ...handlers: RequestHandler<
 P,
 ResBody,
 ReqBody,
 ReqQuery,
 Locals,
 MetaResType,
 >[],
): this
Type Parameters
- P = ParamsDictionary
- ResBody = any
- ReqBody = any
- ReqQuery = ParsedQs
- Locals extends Record<string, any> = Record<string, any>
- MetaResType = any
Parameters
- path: RouteSettings<PathParams, P, ResBody, ReqBody, ReqQuery, Locals, MetaResType>
- ...handlers: RequestHandler<P, ResBody, ReqBody, ReqQuery, Locals, MetaResType>[]
Returns this
Overrides BaseApp.get
- Defined in app.ts:222
get = Record<string, any>,
 MetaResType = any,
>(
 path: RouteSettingsParams<
 PathParams,
 P,
 ResBody,
 ReqBody,
 ReqQuery,
 Locals,
 MetaResType,
 >,
 ...handlers: RequestHandlerParams<
 P,
 ResBody,
 ReqBody,
 ReqQuery,
 Locals,
 MetaResType,
 >[],
): this
Type Parameters
- P = ParamsDictionary
- ResBody = any
- ReqBody = any
- ReqQuery = ParsedQs
- Locals extends Record<string, any> = Record<string, any>
- MetaResType = any
Parameters
- path: RouteSettingsParams<
 PathParams,
 P,
 ResBody,
 ReqBody,
 ReqQuery,
 Locals,
 MetaResType,
 >
- ...handlers: RequestHandlerParams<P, ResBody, ReqBody, ReqQuery, Locals, MetaResType>[]
Returns this
Overrides BaseApp.get
- Defined in app.ts:237
get<
 Route extends string,
 P = RouteParameters<Route>,
 ResBody = any,
 ReqBody = any,
 ReqQuery = ParsedQs,
 Locals extends Record<string, any> = Record<string, any>,
>(
 path: Route,
 ...handlers: RequestHandler<P, ResBody, ReqBody, ReqQuery, Locals, any>[],
): this
Type Parameters
- Route extends string
- P = RouteParameters<Route>
- ResBody = any
- ReqBody = any
- ReqQuery = ParsedQs
- Locals extends Record<string, any> = Record<string, any>
Parameters
- path: Route
- ...handlers: RequestHandler<P, ResBody, ReqBody, ReqQuery, Locals, any>[]
Returns this
Overrides BaseApp.get
- Defined in app.ts:252
get<
 Path extends string,
 P = RouteParameters<Path>,
 ResBody = any,
 ReqBody = any,
 ReqQuery = ParsedQs,
 Locals extends Record<string, any> = Record<string, any>,
>(
 path: Path,
 ...handlers: RequestHandlerParams<P, ResBody, ReqBody, ReqQuery, Locals>[],
): this
Type Parameters
- Path extends string
- P = RouteParameters<Path>
- ResBody = any
- ReqBody = any
- ReqQuery = ParsedQs
- Locals extends Record<string, any> = Record<string, any>
Parameters
- path: Path
- ...handlers: RequestHandlerParams<P, ResBody, ReqBody, ReqQuery, Locals>[]
Returns this
Overrides BaseApp.get
- Defined in app.ts:266
get = Record<string, any>,
>(
 path: PathParams,
 ...handlers: RequestHandler<P, ResBody, ReqBody, ReqQuery, Locals, any>[],
): this
Type Parameters
- P = ParamsDictionary
- ResBody = any
- ReqBody = any
- ReqQuery = ParsedQs
- Locals extends Record<string, any> = Record<string, any>
Parameters
- path: PathParams
- ...handlers: RequestHandler<P, ResBody, ReqBody, ReqQuery, Locals, any>[]
Returns this
Overrides BaseApp.get
- Defined in app.ts:280
get = Record<string, any>,
>(
 path: PathParams,
 ...handlers: RequestHandlerParams<P, ResBody, ReqBody, ReqQuery, Locals>[],
): this
Type Parameters
- P = ParamsDictionary
- ResBody = any
- ReqBody = any
- ReqQuery = ParsedQs
- Locals extends Record<string, any> = Record<string, any>
Parameters
- path: PathParams
- ...handlers: RequestHandlerParams<P, ResBody, ReqBody, ReqQuery, Locals>[]
Returns this
Overrides BaseApp.get
- Defined in app.ts:293
get(path: PathParams, subApplication: Application): this
Parameters
- path: PathParams
- subApplication: Application
Returns this
Overrides BaseApp.get
- Defined in app.ts:306

head

head<
 Route extends string,
 P = RouteParameters<Route>,
 ResBody = any,
 ReqBody = any,
 ReqQuery = ParsedQs,
 Locals extends Record<string, any> = Record<string, any>,
 MetaResType = any,
>(
 path: RouteSettings<
 Route,
 P,
 ResBody,
 ReqBody,
 ReqQuery,
 Locals,
 MetaResType,
 >,
 ...handlers: RequestHandler<
 P,
 ResBody,
 ReqBody,
 ReqQuery,
 Locals,
 MetaResType,
 >[],
): this
Type Parameters
- Route extends string
- P = RouteParameters<Route>
- ResBody = any
- ReqBody = any
- ReqQuery = ParsedQs
- Locals extends Record<string, any> = Record<string, any>
- MetaResType = any
Parameters
- path: RouteSettings<Route, P, ResBody, ReqBody, ReqQuery, Locals, MetaResType>
- ...handlers: RequestHandler<P, ResBody, ReqBody, ReqQuery, Locals, MetaResType>[]
Returns this
- Defined in app.ts:939
head<
 Path extends string,
 P = RouteParameters<Path>,
 ResBody = any,
 ReqBody = any,
 ReqQuery = ParsedQs,
 Locals extends Record<string, any> = Record<string, any>,
 MetaResType = any,
>(
 path: RouteSettingsParams<
 Path,
 P,
 ResBody,
 ReqBody,
 ReqQuery,
 Locals,
 MetaResType,
 >,
 ...handlers: RequestHandlerParams<
 P,
 ResBody,
 ReqBody,
 ReqQuery,
 Locals,
 MetaResType,
 >[],
): this
Type Parameters
- Path extends string
- P = RouteParameters<Path>
- ResBody = any
- ReqBody = any
- ReqQuery = ParsedQs
- Locals extends Record<string, any> = Record<string, any>
- MetaResType = any
Parameters
- path: RouteSettingsParams<Path, P, ResBody, ReqBody, ReqQuery, Locals, MetaResType>
- ...handlers: RequestHandlerParams<P, ResBody, ReqBody, ReqQuery, Locals, MetaResType>[]
Returns this
- Defined in app.ts:955
head = Record<string, any>,
 MetaResType = any,
>(
 path: RouteSettings<
 PathParams,
 P,
 ResBody,
 ReqBody,
 ReqQuery,
 Locals,
 MetaResType,
 >,
 ...handlers: RequestHandler<
 P,
 ResBody,
 ReqBody,
 ReqQuery,
 Locals,
 MetaResType,
 >[],
): this
Type Parameters
- P = ParamsDictionary
- ResBody = any
- ReqBody = any
- ReqQuery = ParsedQs
- Locals extends Record<string, any> = Record<string, any>
- MetaResType = any
Parameters
- path: RouteSettings<PathParams, P, ResBody, ReqBody, ReqQuery, Locals, MetaResType>
- ...handlers: RequestHandler<P, ResBody, ReqBody, ReqQuery, Locals, MetaResType>[]
Returns this
- Defined in app.ts:971
head = Record<string, any>,
 MetaResType = any,
>(
 path: RouteSettingsParams<
 PathParams,
 P,
 ResBody,
 ReqBody,
 ReqQuery,
 Locals,
 MetaResType,
 >,
 ...handlers: RequestHandlerParams<
 P,
 ResBody,
 ReqBody,
 ReqQuery,
 Locals,
 MetaResType,
 >[],
): this
Type Parameters
- P = ParamsDictionary
- ResBody = any
- ReqBody = any
- ReqQuery = ParsedQs
- Locals extends Record<string, any> = Record<string, any>
- MetaResType = any
Parameters
- path: RouteSettingsParams<
 PathParams,
 P,
 ResBody,
 ReqBody,
 ReqQuery,
 Locals,
 MetaResType,
 >
- ...handlers: RequestHandlerParams<P, ResBody, ReqBody, ReqQuery, Locals, MetaResType>[]
Returns this
- Defined in app.ts:986
head<
 Route extends string,
 P = RouteParameters<Route>,
 ResBody = any,
 ReqBody = any,
 ReqQuery = ParsedQs,
 Locals extends Record<string, any> = Record<string, any>,
>(
 path: Route,
 ...handlers: RequestHandler<P, ResBody, ReqBody, ReqQuery, Locals, any>[],
): this
Type Parameters
- Route extends string
- P = RouteParameters<Route>
- ResBody = any
- ReqBody = any
- ReqQuery = ParsedQs
- Locals extends Record<string, any> = Record<string, any>
Parameters
- path: Route
- ...handlers: RequestHandler<P, ResBody, ReqBody, ReqQuery, Locals, any>[]
Returns this
- Defined in app.ts:1001
head<
 Path extends string,
 P = RouteParameters<Path>,
 ResBody = any,
 ReqBody = any,
 ReqQuery = ParsedQs,
 Locals extends Record<string, any> = Record<string, any>,
>(
 path: Path,
 ...handlers: RequestHandlerParams<P, ResBody, ReqBody, ReqQuery, Locals>[],
): this
Type Parameters
- Path extends string
- P = RouteParameters<Path>
- ResBody = any
- ReqBody = any
- ReqQuery = ParsedQs
- Locals extends Record<string, any> = Record<string, any>
Parameters
- path: Path
- ...handlers: RequestHandlerParams<P, ResBody, ReqBody, ReqQuery, Locals>[]
Returns this
- Defined in app.ts:1015
head = Record<string, any>,
>(
 path: PathParams,
 ...handlers: RequestHandler<P, ResBody, ReqBody, ReqQuery, Locals, any>[],
): this
Type Parameters
- P = ParamsDictionary
- ResBody = any
- ReqBody = any
- ReqQuery = ParsedQs
- Locals extends Record<string, any> = Record<string, any>
Parameters
- path: PathParams
- ...handlers: RequestHandler<P, ResBody, ReqBody, ReqQuery, Locals, any>[]
Returns this
- Defined in app.ts:1029
head = Record<string, any>,
>(
 path: PathParams,
 ...handlers: RequestHandlerParams<P, ResBody, ReqBody, ReqQuery, Locals>[],
): this
Type Parameters
- P = ParamsDictionary
- ResBody = any
- ReqBody = any
- ReqQuery = ParsedQs
- Locals extends Record<string, any> = Record<string, any>
Parameters
- path: PathParams
- ...handlers: RequestHandlerParams<P, ResBody, ReqBody, ReqQuery, Locals>[]
Returns this
- Defined in app.ts:1042
head(path: PathParams, subApplication: Application): this
Parameters
- path: PathParams
- subApplication: Application
Returns this
- Defined in app.ts:1055

lazyrouter

lazyrouter(options?: RouterOptions): IRouter
Creates a router and adds it to the application.
Parameters
- Optionaloptions: RouterOptions
Returns IRouter
The created router
Inherited from BaseApp.lazyrouter
- Defined in baseApp.ts:329

listen

listen(
    port?: number,
    hostname?: string,
    backlog?: number,
    listeningListener?: () => void,
): Server
Parameters
- Optionalport: number
- Optionalhostname: string
- Optionalbacklog: number
- OptionallisteningListener: () => void
Returns Server
Inherited from BaseApp.listen
- Defined in baseApp.ts:252
listen(port?: number, hostname?: string, listeningListener?: () => void): Server
Parameters
- Optionalport: number
- Optionalhostname: string
- OptionallisteningListener: () => void
Returns Server
Inherited from BaseApp.listen
- Defined in baseApp.ts:253
listen(port?: number, backlog?: number, listeningListener?: () => void): Server
Parameters
- Optionalport: number
- Optionalbacklog: number
- OptionallisteningListener: () => void
Returns Server
Inherited from BaseApp.listen
- Defined in baseApp.ts:254
listen(port?: number, listeningListener?: () => void): Server
Parameters
- Optionalport: number
- OptionallisteningListener: () => void
Returns Server
Inherited from BaseApp.listen
- Defined in baseApp.ts:255
listen(path: string, backlog?: number, listeningListener?: () => void): Server
Parameters
- path: string
- Optionalbacklog: number
- OptionallisteningListener: () => void
Returns Server
Inherited from BaseApp.listen
- Defined in baseApp.ts:256
listen(path: string, listeningListener?: () => void): Server
Parameters
- path: string
- OptionallisteningListener: () => void
Returns Server
Inherited from BaseApp.listen
- Defined in baseApp.ts:257
listen(options: ListenOptions, listeningListener?: () => void): Server
Parameters
- options: ListenOptions
- OptionallisteningListener: () => void
Returns Server
Inherited from BaseApp.listen
- Defined in baseApp.ts:258
listen(
    handle: unknown,
    backlog?: number,
    listeningListener?: () => void,
): Server
Parameters
- handle: unknown
- Optionalbacklog: number
- OptionallisteningListener: () => void
Returns Server
Inherited from BaseApp.listen
- Defined in baseApp.ts:259
listen(handle: unknown, listeningListener?: () => void): Server
Parameters
- handle: unknown
- OptionallisteningListener: () => void
Returns Server
Inherited from BaseApp.listen
- Defined in baseApp.ts:260

on

on(event: string, callback: (parent: Application) => void): this
Parameters
- event: string
- callback: (parent: Application) => void
Returns this
Overrides BaseApp.on
- Defined in app.ts:39

options

options<
 Route extends string,
 P = RouteParameters<Route>,
 ResBody = any,
 ReqBody = any,
 ReqQuery = ParsedQs,
 Locals extends Record<string, any> = Record<string, any>,
 MetaResType = any,
>(
 path: RouteSettings<
 Route,
 P,
 ResBody,
 ReqBody,
 ReqQuery,
 Locals,
 MetaResType,
 >,
 ...handlers: RequestHandler<
 P,
 ResBody,
 ReqBody,
 ReqQuery,
 Locals,
 MetaResType,
 >[],
): this
Type Parameters
- Route extends string
- P = RouteParameters<Route>
- ResBody = any
- ReqBody = any
- ReqQuery = ParsedQs
- Locals extends Record<string, any> = Record<string, any>
- MetaResType = any
Parameters
- path: RouteSettings<Route, P, ResBody, ReqBody, ReqQuery, Locals, MetaResType>
- ...handlers: RequestHandler<P, ResBody, ReqBody, ReqQuery, Locals, MetaResType>[]
Returns this
- Defined in app.ts:815
options<
 Path extends string,
 P = RouteParameters<Path>,
 ResBody = any,
 ReqBody = any,
 ReqQuery = ParsedQs,
 Locals extends Record<string, any> = Record<string, any>,
 MetaResType = any,
>(
 path: RouteSettingsParams<
 Path,
 P,
 ResBody,
 ReqBody,
 ReqQuery,
 Locals,
 MetaResType,
 >,
 ...handlers: RequestHandlerParams<
 P,
 ResBody,
 ReqBody,
 ReqQuery,
 Locals,
 MetaResType,
 >[],
): this
Type Parameters
- Path extends string
- P = RouteParameters<Path>
- ResBody = any
- ReqBody = any
- ReqQuery = ParsedQs
- Locals extends Record<string, any> = Record<string, any>
- MetaResType = any
Parameters
- path: RouteSettingsParams<Path, P, ResBody, ReqBody, ReqQuery, Locals, MetaResType>
- ...handlers: RequestHandlerParams<P, ResBody, ReqBody, ReqQuery, Locals, MetaResType>[]
Returns this
- Defined in app.ts:831
options = Record<string, any>,
 MetaResType = any,
>(
 path: RouteSettings<
 PathParams,
 P,
 ResBody,
 ReqBody,
 ReqQuery,
 Locals,
 MetaResType,
 >,
 ...handlers: RequestHandler<
 P,
 ResBody,
 ReqBody,
 ReqQuery,
 Locals,
 MetaResType,
 >[],
): this
Type Parameters
- P = ParamsDictionary
- ResBody = any
- ReqBody = any
- ReqQuery = ParsedQs
- Locals extends Record<string, any> = Record<string, any>
- MetaResType = any
Parameters
- path: RouteSettings<PathParams, P, ResBody, ReqBody, ReqQuery, Locals, MetaResType>
- ...handlers: RequestHandler<P, ResBody, ReqBody, ReqQuery, Locals, MetaResType>[]
Returns this
- Defined in app.ts:847
options = Record<string, any>,
 MetaResType = any,
>(
 path: RouteSettingsParams<
 PathParams,
 P,
 ResBody,
 ReqBody,
 ReqQuery,
 Locals,
 MetaResType,
 >,
 ...handlers: RequestHandlerParams<
 P,
 ResBody,
 ReqBody,
 ReqQuery,
 Locals,
 MetaResType,
 >[],
): this
Type Parameters
- P = ParamsDictionary
- ResBody = any
- ReqBody = any
- ReqQuery = ParsedQs
- Locals extends Record<string, any> = Record<string, any>
- MetaResType = any
Parameters
- path: RouteSettingsParams<
 PathParams,
 P,
 ResBody,
 ReqBody,
 ReqQuery,
 Locals,
 MetaResType,
 >
- ...handlers: RequestHandlerParams<P, ResBody, ReqBody, ReqQuery, Locals, MetaResType>[]
Returns this
- Defined in app.ts:862
options<
 Route extends string,
 P = RouteParameters<Route>,
 ResBody = any,
 ReqBody = any,
 ReqQuery = ParsedQs,
 Locals extends Record<string, any> = Record<string, any>,
>(
 path: Route,
 ...handlers: RequestHandler<P, ResBody, ReqBody, ReqQuery, Locals, any>[],
): this
Type Parameters
- Route extends string
- P = RouteParameters<Route>
- ResBody = any
- ReqBody = any
- ReqQuery = ParsedQs
- Locals extends Record<string, any> = Record<string, any>
Parameters
- path: Route
- ...handlers: RequestHandler<P, ResBody, ReqBody, ReqQuery, Locals, any>[]
Returns this
- Defined in app.ts:877
options<
 Path extends string,
 P = RouteParameters<Path>,
 ResBody = any,
 ReqBody = any,
 ReqQuery = ParsedQs,
 Locals extends Record<string, any> = Record<string, any>,
>(
 path: Path,
 ...handlers: RequestHandlerParams<P, ResBody, ReqBody, ReqQuery, Locals>[],
): this
Type Parameters
- Path extends string
- P = RouteParameters<Path>
- ResBody = any
- ReqBody = any
- ReqQuery = ParsedQs
- Locals extends Record<string, any> = Record<string, any>
Parameters
- path: Path
- ...handlers: RequestHandlerParams<P, ResBody, ReqBody, ReqQuery, Locals>[]
Returns this
- Defined in app.ts:891
options = Record<string, any>,
>(
 path: PathParams,
 ...handlers: RequestHandler<P, ResBody, ReqBody, ReqQuery, Locals, any>[],
): this
Type Parameters
- P = ParamsDictionary
- ResBody = any
- ReqBody = any
- ReqQuery = ParsedQs
- Locals extends Record<string, any> = Record<string, any>
Parameters
- path: PathParams
- ...handlers: RequestHandler<P, ResBody, ReqBody, ReqQuery, Locals, any>[]
Returns this
- Defined in app.ts:905
options = Record<string, any>,
>(
 path: PathParams,
 ...handlers: RequestHandlerParams<P, ResBody, ReqBody, ReqQuery, Locals>[],
): this
Type Parameters
- P = ParamsDictionary
- ResBody = any
- ReqBody = any
- ReqQuery = ParsedQs
- Locals extends Record<string, any> = Record<string, any>
Parameters
- path: PathParams
- ...handlers: RequestHandlerParams<P, ResBody, ReqBody, ReqQuery, Locals>[]
Returns this
- Defined in app.ts:918
options(path: PathParams, subApplication: Application): this
Parameters
- path: PathParams
- subApplication: Application
Returns this
- Defined in app.ts:931

param

param(name: string | string[], handler: RequestParamHandler): this
Parameters
- name: string | string[]
- handler: RequestParamHandler
Returns this
- Defined in app.ts:51

patch

patch<
 Route extends string,
 P = RouteParameters<Route>,
 ResBody = any,
 ReqBody = any,
 ReqQuery = ParsedQs,
 Locals extends Record<string, any> = Record<string, any>,
 MetaResType = any,
>(
 path: RouteSettings<
 Route,
 P,
 ResBody,
 ReqBody,
 ReqQuery,
 Locals,
 MetaResType,
 >,
 ...handlers: RequestHandler<
 P,
 ResBody,
 ReqBody,
 ReqQuery,
 Locals,
 MetaResType,
 >[],
): this
Type Parameters
- Route extends string
- P = RouteParameters<Route>
- ResBody = any
- ReqBody = any
- ReqQuery = ParsedQs
- Locals extends Record<string, any> = Record<string, any>
- MetaResType = any
Parameters
- path: RouteSettings<Route, P, ResBody, ReqBody, ReqQuery, Locals, MetaResType>
- ...handlers: RequestHandler<P, ResBody, ReqBody, ReqQuery, Locals, MetaResType>[]
Returns this
- Defined in app.ts:691
patch<
 Path extends string,
 P = RouteParameters<Path>,
 ResBody = any,
 ReqBody = any,
 ReqQuery = ParsedQs,
 Locals extends Record<string, any> = Record<string, any>,
 MetaResType = any,
>(
 path: RouteSettingsParams<
 Path,
 P,
 ResBody,
 ReqBody,
 ReqQuery,
 Locals,
 MetaResType,
 >,
 ...handlers: RequestHandlerParams<
 P,
 ResBody,
 ReqBody,
 ReqQuery,
 Locals,
 MetaResType,
 >[],
): this
Type Parameters
- Path extends string
- P = RouteParameters<Path>
- ResBody = any
- ReqBody = any
- ReqQuery = ParsedQs
- Locals extends Record<string, any> = Record<string, any>
- MetaResType = any
Parameters
- path: RouteSettingsParams<Path, P, ResBody, ReqBody, ReqQuery, Locals, MetaResType>
- ...handlers: RequestHandlerParams<P, ResBody, ReqBody, ReqQuery, Locals, MetaResType>[]
Returns this
- Defined in app.ts:707
patch = Record<string, any>,
 MetaResType = any,
>(
 path: RouteSettings<
 PathParams,
 P,
 ResBody,
 ReqBody,
 ReqQuery,
 Locals,
 MetaResType,
 >,
 ...handlers: RequestHandler<
 P,
 ResBody,
 ReqBody,
 ReqQuery,
 Locals,
 MetaResType,
 >[],
): this
Type Parameters
- P = ParamsDictionary
- ResBody = any
- ReqBody = any
- ReqQuery = ParsedQs
- Locals extends Record<string, any> = Record<string, any>
- MetaResType = any
Parameters
- path: RouteSettings<PathParams, P, ResBody, ReqBody, ReqQuery, Locals, MetaResType>
- ...handlers: RequestHandler<P, ResBody, ReqBody, ReqQuery, Locals, MetaResType>[]
Returns this
- Defined in app.ts:723
patch = Record<string, any>,
 MetaResType = any,
>(
 path: RouteSettingsParams<
 PathParams,
 P,
 ResBody,
 ReqBody,
 ReqQuery,
 Locals,
 MetaResType,
 >,
 ...handlers: RequestHandlerParams<
 P,
 ResBody,
 ReqBody,
 ReqQuery,
 Locals,
 MetaResType,
 >[],
): this
Type Parameters
- P = ParamsDictionary
- ResBody = any
- ReqBody = any
- ReqQuery = ParsedQs
- Locals extends Record<string, any> = Record<string, any>
- MetaResType = any
Parameters
- path: RouteSettingsParams<
 PathParams,
 P,
 ResBody,
 ReqBody,
 ReqQuery,
 Locals,
 MetaResType,
 >
- ...handlers: RequestHandlerParams<P, ResBody, ReqBody, ReqQuery, Locals, MetaResType>[]
Returns this
- Defined in app.ts:738
patch<
 Route extends string,
 P = RouteParameters<Route>,
 ResBody = any,
 ReqBody = any,
 ReqQuery = ParsedQs,
 Locals extends Record<string, any> = Record<string, any>,
>(
 path: Route,
 ...handlers: RequestHandler<P, ResBody, ReqBody, ReqQuery, Locals, any>[],
): this
Type Parameters
- Route extends string
- P = RouteParameters<Route>
- ResBody = any
- ReqBody = any
- ReqQuery = ParsedQs
- Locals extends Record<string, any> = Record<string, any>
Parameters
- path: Route
- ...handlers: RequestHandler<P, ResBody, ReqBody, ReqQuery, Locals, any>[]
Returns this
- Defined in app.ts:753
patch<
 Path extends string,
 P = RouteParameters<Path>,
 ResBody = any,
 ReqBody = any,
 ReqQuery = ParsedQs,
 Locals extends Record<string, any> = Record<string, any>,
>(
 path: Path,
 ...handlers: RequestHandlerParams<P, ResBody, ReqBody, ReqQuery, Locals>[],
): this
Type Parameters
- Path extends string
- P = RouteParameters<Path>
- ResBody = any
- ReqBody = any
- ReqQuery = ParsedQs
- Locals extends Record<string, any> = Record<string, any>
Parameters
- path: Path
- ...handlers: RequestHandlerParams<P, ResBody, ReqBody, ReqQuery, Locals>[]
Returns this
- Defined in app.ts:767
patch = Record<string, any>,
>(
 path: PathParams,
 ...handlers: RequestHandler<P, ResBody, ReqBody, ReqQuery, Locals, any>[],
): this
Type Parameters
- P = ParamsDictionary
- ResBody = any
- ReqBody = any
- ReqQuery = ParsedQs
- Locals extends Record<string, any> = Record<string, any>
Parameters
- path: PathParams
- ...handlers: RequestHandler<P, ResBody, ReqBody, ReqQuery, Locals, any>[]
Returns this
- Defined in app.ts:781
patch = Record<string, any>,
>(
 path: PathParams,
 ...handlers: RequestHandlerParams<P, ResBody, ReqBody, ReqQuery, Locals>[],
): this
Type Parameters
- P = ParamsDictionary
- ResBody = any
- ReqBody = any
- ReqQuery = ParsedQs
- Locals extends Record<string, any> = Record<string, any>
Parameters
- path: PathParams
- ...handlers: RequestHandlerParams<P, ResBody, ReqBody, ReqQuery, Locals>[]
Returns this
- Defined in app.ts:794
patch(path: PathParams, subApplication: Application): this
Parameters
- path: PathParams
- subApplication: Application
Returns this
- Defined in app.ts:807

post

post<
 Route extends string,
 P = RouteParameters<Route>,
 ResBody = any,
 ReqBody = any,
 ReqQuery = ParsedQs,
 Locals extends Record<string, any> = Record<string, any>,
 MetaResType = any,
>(
 path: RouteSettings<
 Route,
 P,
 ResBody,
 ReqBody,
 ReqQuery,
 Locals,
 MetaResType,
 >,
 ...handlers: RequestHandler<
 P,
 ResBody,
 ReqBody,
 ReqQuery,
 Locals,
 MetaResType,
 >[],
): this
Type Parameters
- Route extends string
- P = RouteParameters<Route>
- ResBody = any
- ReqBody = any
- ReqQuery = ParsedQs
- Locals extends Record<string, any> = Record<string, any>
- MetaResType = any
Parameters
- path: RouteSettings<Route, P, ResBody, ReqBody, ReqQuery, Locals, MetaResType>
- ...handlers: RequestHandler<P, ResBody, ReqBody, ReqQuery, Locals, MetaResType>[]
Returns this
- Defined in app.ts:319
post<
 Path extends string,
 P = RouteParameters<Path>,
 ResBody = any,
 ReqBody = any,
 ReqQuery = ParsedQs,
 Locals extends Record<string, any> = Record<string, any>,
 MetaResType = any,
>(
 path: RouteSettingsParams<
 Path,
 P,
 ResBody,
 ReqBody,
 ReqQuery,
 Locals,
 MetaResType,
 >,
 ...handlers: RequestHandlerParams<
 P,
 ResBody,
 ReqBody,
 ReqQuery,
 Locals,
 MetaResType,
 >[],
): this
Type Parameters
- Path extends string
- P = RouteParameters<Path>
- ResBody = any
- ReqBody = any
- ReqQuery = ParsedQs
- Locals extends Record<string, any> = Record<string, any>
- MetaResType = any
Parameters
- path: RouteSettingsParams<Path, P, ResBody, ReqBody, ReqQuery, Locals, MetaResType>
- ...handlers: RequestHandlerParams<P, ResBody, ReqBody, ReqQuery, Locals, MetaResType>[]
Returns this
- Defined in app.ts:335
post = Record<string, any>,
 MetaResType = any,
>(
 path: RouteSettings<
 PathParams,
 P,
 ResBody,
 ReqBody,
 ReqQuery,
 Locals,
 MetaResType,
 >,
 ...handlers: RequestHandler<
 P,
 ResBody,
 ReqBody,
 ReqQuery,
 Locals,
 MetaResType,
 >[],
): this
Type Parameters
- P = ParamsDictionary
- ResBody = any
- ReqBody = any
- ReqQuery = ParsedQs
- Locals extends Record<string, any> = Record<string, any>
- MetaResType = any
Parameters
- path: RouteSettings<PathParams, P, ResBody, ReqBody, ReqQuery, Locals, MetaResType>
- ...handlers: RequestHandler<P, ResBody, ReqBody, ReqQuery, Locals, MetaResType>[]
Returns this
- Defined in app.ts:351
post = Record<string, any>,
 MetaResType = any,
>(
 path: RouteSettingsParams<
 PathParams,
 P,
 ResBody,
 ReqBody,
 ReqQuery,
 Locals,
 MetaResType,
 >,
 ...handlers: RequestHandlerParams<
 P,
 ResBody,
 ReqBody,
 ReqQuery,
 Locals,
 MetaResType,
 >[],
): this
Type Parameters
- P = ParamsDictionary
- ResBody = any
- ReqBody = any
- ReqQuery = ParsedQs
- Locals extends Record<string, any> = Record<string, any>
- MetaResType = any
Parameters
- path: RouteSettingsParams<
 PathParams,
 P,
 ResBody,
 ReqBody,
 ReqQuery,
 Locals,
 MetaResType,
 >
- ...handlers: RequestHandlerParams<P, ResBody, ReqBody, ReqQuery, Locals, MetaResType>[]
Returns this
- Defined in app.ts:366
post<
 Route extends string,
 P = RouteParameters<Route>,
 ResBody = any,
 ReqBody = any,
 ReqQuery = ParsedQs,
 Locals extends Record<string, any> = Record<string, any>,
>(
 path: Route,
 ...handlers: RequestHandler<P, ResBody, ReqBody, ReqQuery, Locals, any>[],
): this
Type Parameters
- Route extends string
- P = RouteParameters<Route>
- ResBody = any
- ReqBody = any
- ReqQuery = ParsedQs
- Locals extends Record<string, any> = Record<string, any>
Parameters
- path: Route
- ...handlers: RequestHandler<P, ResBody, ReqBody, ReqQuery, Locals, any>[]
Returns this
- Defined in app.ts:381
post<
 Path extends string,
 P = RouteParameters<Path>,
 ResBody = any,
 ReqBody = any,
 ReqQuery = ParsedQs,
 Locals extends Record<string, any> = Record<string, any>,
>(
 path: Path,
 ...handlers: RequestHandlerParams<P, ResBody, ReqBody, ReqQuery, Locals>[],
): this
Type Parameters
- Path extends string
- P = RouteParameters<Path>
- ResBody = any
- ReqBody = any
- ReqQuery = ParsedQs
- Locals extends Record<string, any> = Record<string, any>
Parameters
- path: Path
- ...handlers: RequestHandlerParams<P, ResBody, ReqBody, ReqQuery, Locals>[]
Returns this
- Defined in app.ts:395
post = Record<string, any>,
>(
 path: PathParams,
 ...handlers: RequestHandler<P, ResBody, ReqBody, ReqQuery, Locals, any>[],
): this
Type Parameters
- P = ParamsDictionary
- ResBody = any
- ReqBody = any
- ReqQuery = ParsedQs
- Locals extends Record<string, any> = Record<string, any>
Parameters
- path: PathParams
- ...handlers: RequestHandler<P, ResBody, ReqBody, ReqQuery, Locals, any>[]
Returns this
- Defined in app.ts:409
post = Record<string, any>,
>(
 path: PathParams,
 ...handlers: RequestHandlerParams<P, ResBody, ReqBody, ReqQuery, Locals>[],
): this
Type Parameters
- P = ParamsDictionary
- ResBody = any
- ReqBody = any
- ReqQuery = ParsedQs
- Locals extends Record<string, any> = Record<string, any>
Parameters
- path: PathParams
- ...handlers: RequestHandlerParams<P, ResBody, ReqBody, ReqQuery, Locals>[]
Returns this
- Defined in app.ts:422
post(path: PathParams, subApplication: Application): this
Parameters
- path: PathParams
- subApplication: Application
Returns this
- Defined in app.ts:435

put

put<
 Route extends string,
 P = RouteParameters<Route>,
 ResBody = any,
 ReqBody = any,
 ReqQuery = ParsedQs,
 Locals extends Record<string, any> = Record<string, any>,
 MetaResType = any,
>(
 path: RouteSettings<
 Route,
 P,
 ResBody,
 ReqBody,
 ReqQuery,
 Locals,
 MetaResType,
 >,
 ...handlers: RequestHandler<
 P,
 ResBody,
 ReqBody,
 ReqQuery,
 Locals,
 MetaResType,
 >[],
): this
Type Parameters
- Route extends string
- P = RouteParameters<Route>
- ResBody = any
- ReqBody = any
- ReqQuery = ParsedQs
- Locals extends Record<string, any> = Record<string, any>
- MetaResType = any
Parameters
- path: RouteSettings<Route, P, ResBody, ReqBody, ReqQuery, Locals, MetaResType>
- ...handlers: RequestHandler<P, ResBody, ReqBody, ReqQuery, Locals, MetaResType>[]
Returns this
- Defined in app.ts:443
put<
 Path extends string,
 P = RouteParameters<Path>,
 ResBody = any,
 ReqBody = any,
 ReqQuery = ParsedQs,
 Locals extends Record<string, any> = Record<string, any>,
 MetaResType = any,
>(
 path: RouteSettingsParams<
 Path,
 P,
 ResBody,
 ReqBody,
 ReqQuery,
 Locals,
 MetaResType,
 >,
 ...handlers: RequestHandlerParams<
 P,
 ResBody,
 ReqBody,
 ReqQuery,
 Locals,
 MetaResType,
 >[],
): this
Type Parameters
- Path extends string
- P = RouteParameters<Path>
- ResBody = any
- ReqBody = any
- ReqQuery = ParsedQs
- Locals extends Record<string, any> = Record<string, any>
- MetaResType = any
Parameters
- path: RouteSettingsParams<Path, P, ResBody, ReqBody, ReqQuery, Locals, MetaResType>
- ...handlers: RequestHandlerParams<P, ResBody, ReqBody, ReqQuery, Locals, MetaResType>[]
Returns this
- Defined in app.ts:459
put = Record<string, any>,
 MetaResType = any,
>(
 path: RouteSettings<
 PathParams,
 P,
 ResBody,
 ReqBody,
 ReqQuery,
 Locals,
 MetaResType,
 >,
 ...handlers: RequestHandler<
 P,
 ResBody,
 ReqBody,
 ReqQuery,
 Locals,
 MetaResType,
 >[],
): this
Type Parameters
- P = ParamsDictionary
- ResBody = any
- ReqBody = any
- ReqQuery = ParsedQs
- Locals extends Record<string, any> = Record<string, any>
- MetaResType = any
Parameters
- path: RouteSettings<PathParams, P, ResBody, ReqBody, ReqQuery, Locals, MetaResType>
- ...handlers: RequestHandler<P, ResBody, ReqBody, ReqQuery, Locals, MetaResType>[]
Returns this
- Defined in app.ts:475
put = Record<string, any>,
 MetaResType = any,
>(
 path: RouteSettingsParams<
 PathParams,
 P,
 ResBody,
 ReqBody,
 ReqQuery,
 Locals,
 MetaResType,
 >,
 ...handlers: RequestHandlerParams<
 P,
 ResBody,
 ReqBody,
 ReqQuery,
 Locals,
 MetaResType,
 >[],
): this
Type Parameters
- P = ParamsDictionary
- ResBody = any
- ReqBody = any
- ReqQuery = ParsedQs
- Locals extends Record<string, any> = Record<string, any>
- MetaResType = any
Parameters
- path: RouteSettingsParams<
 PathParams,
 P,
 ResBody,
 ReqBody,
 ReqQuery,
 Locals,
 MetaResType,
 >
- ...handlers: RequestHandlerParams<P, ResBody, ReqBody, ReqQuery, Locals, MetaResType>[]
Returns this
- Defined in app.ts:490
put<
 Route extends string,
 P = RouteParameters<Route>,
 ResBody = any,
 ReqBody = any,
 ReqQuery = ParsedQs,
 Locals extends Record<string, any> = Record<string, any>,
>(
 path: Route,
 ...handlers: RequestHandler<P, ResBody, ReqBody, ReqQuery, Locals, any>[],
): this
Type Parameters
- Route extends string
- P = RouteParameters<Route>
- ResBody = any
- ReqBody = any
- ReqQuery = ParsedQs
- Locals extends Record<string, any> = Record<string, any>
Parameters
- path: Route
- ...handlers: RequestHandler<P, ResBody, ReqBody, ReqQuery, Locals, any>[]
Returns this
- Defined in app.ts:505
put<
 Path extends string,
 P = RouteParameters<Path>,
 ResBody = any,
 ReqBody = any,
 ReqQuery = ParsedQs,
 Locals extends Record<string, any> = Record<string, any>,
>(
 path: Path,
 ...handlers: RequestHandlerParams<P, ResBody, ReqBody, ReqQuery, Locals>[],
): this
Type Parameters
- Path extends string
- P = RouteParameters<Path>
- ResBody = any
- ReqBody = any
- ReqQuery = ParsedQs
- Locals extends Record<string, any> = Record<string, any>
Parameters
- path: Path
- ...handlers: RequestHandlerParams<P, ResBody, ReqBody, ReqQuery, Locals>[]
Returns this
- Defined in app.ts:519
put = Record<string, any>,
>(
 path: PathParams,
 ...handlers: RequestHandler<P, ResBody, ReqBody, ReqQuery, Locals, any>[],
): this
Type Parameters
- P = ParamsDictionary
- ResBody = any
- ReqBody = any
- ReqQuery = ParsedQs
- Locals extends Record<string, any> = Record<string, any>
Parameters
- path: PathParams
- ...handlers: RequestHandler<P, ResBody, ReqBody, ReqQuery, Locals, any>[]
Returns this
- Defined in app.ts:533
put = Record<string, any>,
>(
 path: PathParams,
 ...handlers: RequestHandlerParams<P, ResBody, ReqBody, ReqQuery, Locals>[],
): this
Type Parameters
- P = ParamsDictionary
- ResBody = any
- ReqBody = any
- ReqQuery = ParsedQs
- Locals extends Record<string, any> = Record<string, any>
Parameters
- path: PathParams
- ...handlers: RequestHandlerParams<P, ResBody, ReqBody, ReqQuery, Locals>[]
Returns this
- Defined in app.ts:546
put(path: PathParams, subApplication: Application): this
Parameters
- path: PathParams
- subApplication: Application
Returns this
- Defined in app.ts:559

set

set(setting: string, val?: unknown): this
Parameters
- setting: string
- Optionalval: unknown
Returns this
Overrides BaseApp.set
- Defined in app.ts:44

use

use(
 ...handlers: RequestHandler<
 ParamsDictionary,
 any,
 any,
 ParsedQs,
 Record<string, any>,
 >[],
): this
Parameters
- ...handlers: RequestHandler<ParamsDictionary, any, any, ParsedQs, Record<string, any>>[]
Returns this
- Defined in app.ts:1063
use(
 ...handlers: RequestHandlerParams<
 ParamsDictionary,
 any,
 any,
 ParsedQs,
 Record<string, any>,
 >[],
): this
Parameters
- ...handlers: RequestHandlerParams<ParamsDictionary, any, any, ParsedQs, Record<string, any>>[]
Returns this
- Defined in app.ts:1064
use = Record<string, any>,
>(
 ...handlers: RequestHandler<P, ResBody, ReqBody, ReqQuery, Locals>[],
): this
Type Parameters
- P = ParamsDictionary
- ResBody = any
- ReqBody = any
- ReqQuery = ParsedQs
- Locals extends Record<string, any> = Record<string, any>
Parameters
- ...handlers: RequestHandler<P, ResBody, ReqBody, ReqQuery, Locals>[]
Returns this
- Defined in app.ts:1065
use = Record<string, any>,
>(
 ...handlers: RequestHandlerParams<P, ResBody, ReqBody, ReqQuery, Locals>[],
): this
Type Parameters
- P = ParamsDictionary
- ResBody = any
- ReqBody = any
- ReqQuery = ParsedQs
- Locals extends Record<string, any> = Record<string, any>
Parameters
- ...handlers: RequestHandlerParams<P, ResBody, ReqBody, ReqQuery, Locals>[]
Returns this
- Defined in app.ts:1077
use = Record<string, any>,
>(
 ...handlers: RequestHandler<P, ResBody, ReqBody, ReqQuery, Locals>[],
): this
Type Parameters
- P = ParamsDictionary
- ResBody = any
- ReqBody = any
- ReqQuery = ParsedQs
- Locals extends Record<string, any> = Record<string, any>
Parameters
- ...handlers: RequestHandler<P, ResBody, ReqBody, ReqQuery, Locals>[]
Returns this
- Defined in app.ts:1089
use = Record<string, any>,
>(
 ...handlers: RequestHandlerParams<P, ResBody, ReqBody, ReqQuery, Locals>[],
): this
Type Parameters
- P = ParamsDictionary
- ResBody = any
- ReqBody = any
- ReqQuery = ParsedQs
- Locals extends Record<string, any> = Record<string, any>
Parameters
- ...handlers: RequestHandlerParams<P, ResBody, ReqBody, ReqQuery, Locals>[]
Returns this
- Defined in app.ts:1101
use<
 Route extends string,
 P = RouteParameters<Route>,
 ResBody = any,
 ReqBody = any,
 ReqQuery = ParsedQs,
 Locals extends Record<string, any> = Record<string, any>,
>(
 path: Route,
 ...handlers: RequestHandler<P, ResBody, ReqBody, ReqQuery, Locals>[],
): this
Type Parameters
- Route extends string
- P = RouteParameters<Route>
- ResBody = any
- ReqBody = any
- ReqQuery = ParsedQs
- Locals extends Record<string, any> = Record<string, any>
Parameters
- path: Route
- ...handlers: RequestHandler<P, ResBody, ReqBody, ReqQuery, Locals>[]
Returns this
- Defined in app.ts:1113
use<
 Path extends string,
 P = RouteParameters<Path>,
 ResBody = any,
 ReqBody = any,
 ReqQuery = ParsedQs,
 Locals extends Record<string, any> = Record<string, any>,
>(
 path: Path,
 ...handlers: RequestHandlerParams<P, ResBody, ReqBody, ReqQuery, Locals>[],
): this
Type Parameters
- Path extends string
- P = RouteParameters<Path>
- ResBody = any
- ReqBody = any
- ReqQuery = ParsedQs
- Locals extends Record<string, any> = Record<string, any>
Parameters
- path: Path
- ...handlers: RequestHandlerParams<P, ResBody, ReqBody, ReqQuery, Locals>[]
Returns this
- Defined in app.ts:1127
use = Record<string, any>,
>(
 path: PathParams,
 ...handlers: RequestHandler<P, ResBody, ReqBody, ReqQuery, Locals>[],
): this
Type Parameters
- P = ParamsDictionary
- ResBody = any
- ReqBody = any
- ReqQuery = ParsedQs
- Locals extends Record<string, any> = Record<string, any>
Parameters
- path: PathParams
- ...handlers: RequestHandler<P, ResBody, ReqBody, ReqQuery, Locals>[]
Returns this
- Defined in app.ts:1143
use = Record<string, any>,
>(
 path: PathParams,
 ...handlers: RequestHandlerParams<P, ResBody, ReqBody, ReqQuery, Locals>[],
): this
Type Parameters
- P = ParamsDictionary
- ResBody = any
- ReqBody = any
- ReqQuery = ParsedQs
- Locals extends Record<string, any> = Record<string, any>
Parameters
- path: PathParams
- ...handlers: RequestHandlerParams<P, ResBody, ReqBody, ReqQuery, Locals>[]
Returns this
- Defined in app.ts:1156
use(path: PathParams, subApplication: Application): this
Parameters
- path: PathParams
- subApplication: Application
Returns this
- Defined in app.ts:1169

useError

useError = Record<string, any>,
>(
 ...handlers: RequestHandlerParams<P, ResBody, ReqBody, ReqQuery, Locals>[],
): this
Type Parameters
- P = ParamsDictionary
- ResBody = any
- ReqBody = any
- ReqQuery = ParsedQs
- Locals extends Record<string, any> = Record<string, any>
Parameters
- ...handlers: RequestHandlerParams<P, ResBody, ReqBody, ReqQuery, Locals>[]
Returns this
Inherited from BaseApp.useError
- Defined in baseApp.ts:378

Class FrameworkApp

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns FrameworkApp

Properties

Protected__app

Protected__router

Accessors

_app

Returns Application

_router

Returns IRouter

building

Returns boolean

built

Returns boolean

meta

Returns RouteMeta[]

server

Returns undefined | Server<typeof IncomingMessage, typeof ServerResponse>

Methods

addFrameworkOptions

Parameters

Returns this

addOptions

Parameters

Returns this

addRouters

Parameters

Returns this

all

Type Parameters

Parameters

Returns this

Type Parameters

Parameters

Returns this

Type Parameters

Parameters

Returns this

Type Parameters

Parameters

Returns this

Type Parameters

Parameters

Returns this

Type Parameters

Parameters

Returns this

Type Parameters

Parameters

Returns this

Type Parameters

Parameters

Returns this

Parameters

Returns this

build

Type Parameters

Parameters

Returns Server

Example

delete

Type Parameters

Parameters

Returns this

Type Parameters

Parameters

Returns this

Type Parameters

Parameters

Returns this

Type Parameters

`Protected`__app

`Protected`__router