Class BaseApp`Abstract`

Abstract application

Hierarchy (View Summary)

BaseApp
- FrameworkApp

Implements

IApp

Index

Constructors

constructor

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

Properties

`Protected`__app

__app: Application

`Protected`__router

__router: IRouter

Accessors

_app

get _app(): Application
Express Application

Returns Application
- Defined in baseApp.ts:55

_router

get _router(): IRouter
Main router

Returns IRouter
- Defined in baseApp.ts:62

building

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

built

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

server

get server(): undefined | Server<typeof IncomingMessage, typeof ServerResponse>
Returns undefined | Server<typeof IncomingMessage, typeof ServerResponse>
Implementation of IApp.server
- Defined in baseApp.ts:78

Methods

addFrameworkOptions

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

addOptions

addOptions(options: Options): this
Parameters
- options: Options
  Options to concatenate with current options.
Returns this
Implementation of IApp.addOptions
- Defined in baseApp.ts:134

addRouters

addRouters(routers: IRouter | IRouter[]): this
Parameters
- routers: IRouter | IRouter[]
Returns this
Implementation of IApp.addRouters
- Defined in baseApp.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);
```
Implementation of IApp.build
- Defined in baseApp.ts:222

disable

disable(setting: string): this
Parameters
- setting: string
Returns this
Implementation of IApp.disable
- Defined in baseApp.ts:337

disabled

disabled(setting: string): boolean
Parameters
- setting: string
Returns boolean
Implementation of IApp.disabled
- Defined in baseApp.ts:342

enable

enable(setting: string): this
Parameters
- setting: string
Returns this
Implementation of IApp.enable
- Defined in baseApp.ts:346

enabled

enabled(setting: string): boolean
Parameters
- setting: string
Returns boolean
Implementation of IApp.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
- Defined in baseApp.ts:366

get

get(setting: string): any
Parameters
- setting: string
Returns any
- Defined in baseApp.ts:372

lazyrouter

lazyrouter(options?: RouterOptions): IRouter
Creates a router and adds it to the application.
Parameters
- Optionaloptions: RouterOptions
Returns IRouter
The created router
- 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
- Defined in baseApp.ts:252
listen(port?: number, hostname?: string, listeningListener?: () => void): Server
Parameters
- Optionalport: number
- Optionalhostname: string
- OptionallisteningListener: () => void
Returns Server
- Defined in baseApp.ts:253
listen(port?: number, backlog?: number, listeningListener?: () => void): Server
Parameters
- Optionalport: number
- Optionalbacklog: number
- OptionallisteningListener: () => void
Returns Server
- Defined in baseApp.ts:254
listen(port?: number, listeningListener?: () => void): Server
Parameters
- Optionalport: number
- OptionallisteningListener: () => void
Returns Server
- Defined in baseApp.ts:255
listen(path: string, backlog?: number, listeningListener?: () => void): Server
Parameters
- path: string
- Optionalbacklog: number
- OptionallisteningListener: () => void
Returns Server
- Defined in baseApp.ts:256
listen(path: string, listeningListener?: () => void): Server
Parameters
- path: string
- OptionallisteningListener: () => void
Returns Server
- Defined in baseApp.ts:257
listen(options: ListenOptions, listeningListener?: () => void): Server
Parameters
- options: ListenOptions
- OptionallisteningListener: () => void
Returns Server
- Defined in baseApp.ts:258
listen(
    handle: unknown,
    backlog?: number,
    listeningListener?: () => void,
): Server
Parameters
- handle: unknown
- Optionalbacklog: number
- OptionallisteningListener: () => void
Returns Server
- Defined in baseApp.ts:259
listen(handle: unknown, listeningListener?: () => void): Server
Parameters
- handle: unknown
- OptionallisteningListener: () => void
Returns Server
- Defined in baseApp.ts:260

on

on(event: string, callback: (parent: Application) => void): this
Parameters
- event: string
- callback: (parent: Application) => void
Returns this
Implementation of IApp.on
- Defined in baseApp.ts:355

set

set(setting: string, val?: unknown): this
Parameters
- setting: string
- Optionalval: unknown
Returns this
- Defined in baseApp.ts:360

useError

useError<
    P = ParamsDictionary,
    ResBody = any,
    ReqBody = any,
    ReqQuery = ParsedQs,
    Locals extends Record<string, any> = 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 baseApp.ts:378

Class BaseAppAbstract

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns BaseApp

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

build

Type Parameters

Parameters

Returns Server

Example

disable

Parameters

Returns this

disabled

Parameters

Returns boolean

enable

Parameters

Returns this

enabled

Parameters

Returns boolean

engine

Parameters

Returns this

get

Parameters

Returns any

lazyrouter

Parameters

Returns IRouter

listen

Parameters

Returns Server

Parameters

Returns Server

Parameters

Returns Server

Parameters

Returns Server

Parameters

Returns Server

Parameters

Returns Server

Parameters

Returns Server

Parameters

Class BaseApp`Abstract`

`Protected`__app

`Protected`__router