Class Frame

The application

Hierarchy (view full)

Constructors

constructor

Properties

__app __router docs

Accessors

_app _router building built meta openapi postman server

Methods

addFrameworkOptions addOptions addRouters all build delete disable disabled enable enabled engine get head lazyrouter listen on options param patch post put refreshDocs set use useError

Constructors

constructor

Properties

Protected__app

__app: Application

Protected__router

__router: IRouter

Protecteddocs

docs: {
    openapi: OpenAPI;
    postman: Postman;
}

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[]

openapi

postman

server

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

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

Methods

addFrameworkOptions

addOptions

addRouters

all

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

delete

disable

disabled

  • disabled(setting): boolean

  • Parameters

    • setting: string

    Returns boolean

enable

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

head

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): FrameworkApp

  • Parameters

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

        • Parameters

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

          Returns void

    Returns FrameworkApp

options

param

patch

post

put

refreshDocs

  • refreshDocs(): void

  • Returns void

    TODO

    fix refresh for postman (problem: it adds the same routes multiple time)

set

use

useError

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods