Class ZibriApplication

A Zibri application.

Index

Constructors

Properties

Methods

init shutdown start use

Constructors

constructor

new ZibriApplication(providedOptions: ZibriApplicationOptions): ZibriApplication
Parameters
- providedOptions: ZibriApplicationOptions
Returns ZibriApplication
- Defined in src/application.ts:80

Properties

`Readonly`options

options: FullZibriApplicationOptions

The options of which the application was build.

`Readonly`server

server: Server = ...

The underlying http server.

Methods

init

init(H: typeof Handlebars, handlebarComponentsDir?: string): Promise<void>
Initializes the app.
Parameters
- H: typeof Handlebars
  The global handlebars instance, needed to provide some helpers used in templating.
- handlebarComponentsDir: string = ...
  Directory where handlebars components reside. Defaults to assetService.assetsPath/templates/components.
Returns Promise<void>
- Defined in src/application.ts:113

shutdown

shutdown(signal?: "SIGHUP" | "SIGINT" | "SIGTERM"): Promise<void>
Gracefully shuts down the application.
Parameters
- Optionalsignal: "SIGHUP" | "SIGINT" | "SIGTERM"
  The signal that shuts down the application. Can be left empty if manually called.
Returns Promise<void>
- Defined in src/application.ts:179

start

start(port: number): Promise<void>
Starts on the given port.
Parameters
- port: number
  The port to start on.
Returns Promise<void>
Throws
When the app has already been started.
- Defined in src/application.ts:155

use

use(handler: RequestHandler): void
Parameters
- handler: RequestHandler
Returns void
- Defined in src/application.ts:93
use(errorHandler: GlobalErrorHandler): void
Parameters
- errorHandler: GlobalErrorHandler
Returns void
- Defined in src/application.ts:95
use(
    ...handlers: RequestHandler<
        ParamsDictionary,
        any,
        any,
        ParsedQs,
        Record<string, any>,
    >[],
): void
Parameters
- ...handlers: RequestHandler<ParamsDictionary, any, any, ParsedQs, Record<string, any>>[]
Returns void
- Defined in src/application.ts:97
use(
    path: `/${string}`,
    ...handlers: RequestHandler<
        ParamsDictionary,
        any,
        any,
        ParsedQs,
        Record<string, any>,
    >[],
): void
Parameters
- path: `/${string}`
- ...handlers: RequestHandler<ParamsDictionary, any, any, ParsedQs, Record<string, any>>[]
Returns void
- Defined in src/application.ts:99
use(
    path: `/${string}`,
    handlers: RequestHandler<
        ParamsDictionary,
        any,
        any,
        ParsedQs,
        Record<string, any>,
    >[],
): void
Parameters
- path: `/${string}`
- handlers: RequestHandler<ParamsDictionary, any, any, ParsedQs, Record<string, any>>[]
Returns void
- Defined in src/application.ts:101