Class BaseAppAbstract

Abstract application

Hierarchy (View Summary)

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?: 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

  • Returns undefined | Server

Methods

addFrameworkOptions

  • addFrameworkOptions(options: FrameworkOptions): BaseApp

  • Parameters

    • options: FrameworkOptions

    Returns BaseApp

addOptions

  • addOptions(options: Options): BaseApp

  • Parameters

    • options: Options

      Options to concatenate with current options.

    Returns BaseApp

addRouters

  • addRouters(routers: IRouter | IRouter[]): BaseApp

  • Parameters

    • routers: IRouter | IRouter[]

    Returns BaseApp

build

  • build<T extends ServerOptions = ServerOptions>(
        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 = ServerOptions

    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);

disable

  • disable(setting: string): BaseApp

  • Parameters

    • setting: string

    Returns BaseApp

disabled

  • disabled(setting: string): boolean

  • Parameters

    • setting: string

    Returns boolean

enable

  • enable(setting: string): BaseApp

  • Parameters

    • setting: string

    Returns BaseApp

enabled

  • enabled(setting: string): boolean

  • Parameters

    • setting: string

    Returns boolean

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

get

  • get(setting: string): any

  • Parameters

    • setting: string

    Returns any

lazyrouter

  • lazyrouter(options?: RouterOptions): IRouter

  • Creates a router and adds it to the application.

    Parameters

    • Optionaloptions: RouterOptions

    Returns IRouter

    The created router

listen

  • listen(
        port?: number,
        hostname?: string,
        backlog?: number,
        listeningListener?: () => void,
    ): Server

  • Parameters

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

    Returns Server

  • listen(port?: number, hostname?: string, listeningListener?: () => void): Server

  • Parameters

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

    Returns Server

  • listen(port?: number, backlog?: number, listeningListener?: () => void): Server

  • Parameters

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

    Returns Server

  • listen(port?: number, listeningListener?: () => void): Server

  • Parameters

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

    Returns Server

  • listen(path: string, backlog?: number, listeningListener?: () => void): Server

  • Parameters

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

    Returns Server

  • listen(path: string, listeningListener?: () => void): Server

  • Parameters

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

    Returns Server

  • listen(options: ListenOptions, listeningListener?: () => void): Server

  • Parameters

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

    Returns Server

  • listen(
        handle: unknown,
        backlog?: number,
        listeningListener?: () => void,
    ): Server

  • Parameters

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

    Returns Server

  • listen(handle: unknown, listeningListener?: () => void): Server

  • Parameters

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

    Returns Server

on

  • on(event: string, callback: (parent: Application) => void): BaseApp

  • Parameters

    • event: string
    • callback: (parent: Application) => void

    Returns BaseApp

set

  • set(setting: string, val?: unknown): BaseApp

  • Parameters

    • setting: string
    • Optionalval: unknown

    Returns BaseApp

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>[],
    ): 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