Class BaseAppAbstract

Abstract application

Hierarchy (view full)

Implements

Constructors

constructor

Properties

__app __router

Accessors

_app _router building built meta server

Methods

addFrameworkOptions addOptions addRouters build disable disabled enable enabled engine get lazyrouter listen on set useError

Constructors

constructor

  • new BaseApp(options?): BaseApp

  • Parameters

    Returns BaseApp

Properties

Protected__app

__app: Application

Protected__router

__router: IRouter

Accessors

_app

  • get _app(): Application

  • Express Application

    Returns Application

_router

  • get _router(): IRouter

  • Main router

    Returns IRouter

building

  • get building(): boolean

  • Returns boolean

built

  • get built(): boolean

  • Returns boolean

meta

  • get meta(): RouteMeta[]

  • Returns RouteMeta[]

server

  • get server(): undefined | Server<typeof IncomingMessage, typeof ServerResponse>

  • Returns undefined | Server<typeof IncomingMessage, typeof ServerResponse>

Methods

addFrameworkOptions

  • addFrameworkOptions(options): BaseApp

  • Parameters

    • options: FrameworkOptions

    Returns BaseApp

addOptions

  • addOptions(options): BaseApp

  • Parameters

    • options: Options

      Options to concatenate with current options.

    Returns BaseApp

addRouters

  • addRouters(routers): BaseApp

  • Parameters

    • routers: IRouter | IRouter[]

    Returns BaseApp

build

  • build<T>(options?, mod?): Server<typeof IncomingMessage, typeof ServerResponse>

  • 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<typeof IncomingMessage, typeof ServerResponse>;
          createServer(options: T, requestListener?: RequestListener<typeof IncomingMessage, typeof ServerResponse>): Server<typeof IncomingMessage, typeof ServerResponse>;
      }

      Module that will create the server (e.g.: require('https'))

      • createServer:function
        • createServer(requestListener?): Server<typeof IncomingMessage, typeof ServerResponse>

        • Parameters

          • OptionalrequestListener: RequestListener<typeof IncomingMessage, typeof ServerResponse>

          Returns Server<typeof IncomingMessage, typeof ServerResponse>

        • createServer(options, requestListener?): Server<typeof IncomingMessage, typeof ServerResponse>

        • Parameters

          • options: T
          • OptionalrequestListener: RequestListener<typeof IncomingMessage, typeof ServerResponse>

          Returns Server<typeof IncomingMessage, typeof ServerResponse>

    Returns Server<typeof IncomingMessage, typeof ServerResponse>

    Example

    const https = require('https');
    const server = app.build(HTTPS_SERVER_OPTIONS, https);
    server.listen(PORT);

disable

  • disable(setting): BaseApp

  • Parameters

    • setting: string

    Returns BaseApp

disabled

  • disabled(setting): boolean

  • Parameters

    • setting: string

    Returns boolean

enable

  • enable(setting): BaseApp

  • Parameters

    • setting: string

    Returns BaseApp

enabled

  • enabled(setting): boolean

  • Parameters

    • setting: string

    Returns boolean

engine

  • engine(ext, fn): this

  • Parameters

    • ext: string
    • fn: ((path: string, options: object, callback: ((e: any, rendered?: string) => void)) => void)
        • (path, options, callback): void

        • Parameters

          • path: string
          • options: object
          • callback: ((e: any, rendered?: string) => void)
              • (e, rendered?): void

              • Parameters

                • e: any
                • Optionalrendered: string

                Returns void

          Returns void

    Returns this

get

  • get(setting): any

  • Parameters

    • setting: string

    Returns any

lazyrouter

  • lazyrouter(options?): IRouter

  • Creates a router and adds it to the application.

    Parameters

    • Optionaloptions: RouterOptions

    Returns IRouter

    The created router

listen

  • listen(port?, hostname?, backlog?, listeningListener?): Server<typeof IncomingMessage, typeof ServerResponse>

  • Parameters

    • Optionalport: number
    • Optionalhostname: string
    • Optionalbacklog: number
    • OptionallisteningListener: (() => void)
        • (): void

        • Returns void

    Returns Server<typeof IncomingMessage, typeof ServerResponse>

  • listen(port?, hostname?, listeningListener?): Server<typeof IncomingMessage, typeof ServerResponse>

  • Parameters

    • Optionalport: number
    • Optionalhostname: string
    • OptionallisteningListener: (() => void)
        • (): void

        • Returns void

    Returns Server<typeof IncomingMessage, typeof ServerResponse>

  • listen(port?, backlog?, listeningListener?): Server<typeof IncomingMessage, typeof ServerResponse>

  • Parameters

    • Optionalport: number
    • Optionalbacklog: number
    • OptionallisteningListener: (() => void)
        • (): void

        • Returns void

    Returns Server<typeof IncomingMessage, typeof ServerResponse>

  • listen(port?, listeningListener?): Server<typeof IncomingMessage, typeof ServerResponse>

  • Parameters

    • Optionalport: number
    • OptionallisteningListener: (() => void)
        • (): void

        • Returns void

    Returns Server<typeof IncomingMessage, typeof ServerResponse>

  • listen(path, backlog?, listeningListener?): Server<typeof IncomingMessage, typeof ServerResponse>

  • Parameters

    • path: string
    • Optionalbacklog: number
    • OptionallisteningListener: (() => void)
        • (): void

        • Returns void

    Returns Server<typeof IncomingMessage, typeof ServerResponse>

  • listen(path, listeningListener?): Server<typeof IncomingMessage, typeof ServerResponse>

  • Parameters

    • path: string
    • OptionallisteningListener: (() => void)
        • (): void

        • Returns void

    Returns Server<typeof IncomingMessage, typeof ServerResponse>

  • listen(options, listeningListener?): Server<typeof IncomingMessage, typeof ServerResponse>

  • Parameters

    • options: ListenOptions
    • OptionallisteningListener: (() => void)
        • (): void

        • Returns void

    Returns Server<typeof IncomingMessage, typeof ServerResponse>

  • listen(handle, backlog?, listeningListener?): Server<typeof IncomingMessage, typeof ServerResponse>

  • Parameters

    • handle: unknown
    • Optionalbacklog: number
    • OptionallisteningListener: (() => void)
        • (): void

        • Returns void

    Returns Server<typeof IncomingMessage, typeof ServerResponse>

  • listen(handle, listeningListener?): Server<typeof IncomingMessage, typeof ServerResponse>

  • Parameters

    • handle: unknown
    • OptionallisteningListener: (() => void)
        • (): void

        • Returns void

    Returns Server<typeof IncomingMessage, typeof ServerResponse>

on

  • on(event, callback): BaseApp

  • Parameters

    • event: string
    • callback: ((parent: Application<Record<string, any>>) => void)
        • (parent): void

        • Parameters

          • parent: Application<Record<string, any>>

          Returns void

    Returns BaseApp

set

  • set(setting, val?): BaseApp

  • Parameters

    • setting: string
    • Optionalval: unknown

    Returns BaseApp

useError

  • useError<P, ResBody, ReqBody, ReqQuery, Locals>(...handlers): BaseApp

  • Type Parameters

    • P = ParamsDictionary
    • ResBody = any
    • ReqBody = any
    • ReqQuery = ParsedQs
    • Locals extends Record<string, any> = Record<string, any>

    Parameters

    Returns BaseApp

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods