@novice1/app 0.2.0 → 0.3.0

package/lib/baseApp.d.ts

@@ -1,81 +1,98 @@
-/// <reference types="node" />
-import http from 'http';
-import net from 'net';
-import express from 'express';
-import core from 'express-serve-static-core';
-import { IRouter, RequestHandler, RouteMeta } from '@novice1/routing';
-export interface FrameworkOptions {
-    auth?: RequestHandler[];
-    middlewares?: (core.RequestHandler | core.RequestHandlerParams)[];
-    validators?: RequestHandler[];
-}
-export interface Options {
-    framework?: FrameworkOptions;
-    routers?: IRouter[];
-}
-export interface IApp {
-    get meta(): RouteMeta[];
-    get server(): http.Server | undefined;
-    addRouters(routers: IRouter[] | IRouter): IApp;
-    addOptions(options: Options): IApp;
-    build(options?: http.ServerOptions): http.Server;
-    disable(setting: string): IApp;
-    enable(setting: string): IApp;
-    disabled(setting: string): boolean;
-    enabled(setting: string): boolean;
-    on(event: string, callback: (parent: core.Application) => void): IApp;
-}
-/**
- * Abstract application
- */
-export declare abstract class BaseApp implements IApp {
-    #private;
-    protected __app: express.Application;
-    protected __router: IRouter;
-    /**
-     * Express Application
-     */
-    get _app(): express.Application;
-    /**
-     * Main router
-     */
-    get _router(): IRouter;
-    get building(): boolean;
-    get built(): boolean;
-    get meta(): RouteMeta[];
-    get server(): http.Server | undefined;
-    constructor(options?: Options);
-    private _registerRouter;
-    private _buildFramework;
-    private _buildRoutes;
-    /**
-     *
-     * @param options Options to concatenate with current options.
-     * @returns
-     */
-    addOptions(options: Options): BaseApp;
-    addFrameworkOptions(options: FrameworkOptions): BaseApp;
-    addRouters(routers: IRouter[] | IRouter): BaseApp;
-    build(options?: http.ServerOptions): http.Server;
-    listen(port?: number, hostname?: string, backlog?: number, listeningListener?: () => void): http.Server;
-    listen(port?: number, hostname?: string, listeningListener?: () => void): http.Server;
-    listen(port?: number, backlog?: number, listeningListener?: () => void): http.Server;
-    listen(port?: number, listeningListener?: () => void): http.Server;
-    listen(path: string, backlog?: number, listeningListener?: () => void): http.Server;
-    listen(path: string, listeningListener?: () => void): http.Server;
-    listen(options: net.ListenOptions, listeningListener?: () => void): http.Server;
-    listen(handle: unknown, backlog?: number, listeningListener?: () => void): http.Server;
-    listen(handle: unknown, listeningListener?: () => void): http.Server;
-    /**
-     * Creates a router and adds it to the application.
-     * @returns The created router
-     */
-    lazyrouter(options?: express.RouterOptions): IRouter;
-    disable(setting: string): BaseApp;
-    disabled(setting: string): boolean;
-    enable(setting: string): BaseApp;
-    enabled(setting: string): boolean;
-    on(event: string, callback: (parent: core.Application) => void): BaseApp;
-    set(setting: string, val?: unknown): BaseApp;
-    get(setting: string): any;
-}
+/// <reference types="node" />
+/// <reference types="node" />
+import http from 'http';
+import net from 'net';
+import express from 'express';
+import core from 'express-serve-static-core';
+import { IRouter, RequestHandler, RouteMeta } from '@novice1/routing';
+export interface FrameworkOptions {
+    auth?: RequestHandler[];
+    middlewares?: (core.RequestHandler | core.RequestHandlerParams)[];
+    validators?: RequestHandler[];
+}
+export interface Options {
+    framework?: FrameworkOptions;
+    routers?: IRouter[];
+}
+export interface IApp {
+    get meta(): RouteMeta[];
+    get server(): http.Server | undefined;
+    addRouters(routers: IRouter[] | IRouter): IApp;
+    addOptions(options: Options): IApp;
+    build<T extends http.ServerOptions = http.ServerOptions>(options?: T | null, mod?: {
+        createServer(requestListener?: http.RequestListener): http.Server;
+        createServer(options: T, requestListener?: http.RequestListener | undefined): http.Server;
+    }): http.Server;
+    disable(setting: string): IApp;
+    enable(setting: string): IApp;
+    disabled(setting: string): boolean;
+    enabled(setting: string): boolean;
+    on(event: string, callback: (parent: core.Application) => void): IApp;
+}
+/**
+ * Abstract application
+ */
+export declare abstract class BaseApp implements IApp {
+    #private;
+    protected __app: express.Application;
+    protected __router: IRouter;
+    /**
+     * Express Application
+     */
+    get _app(): express.Application;
+    /**
+     * Main router
+     */
+    get _router(): IRouter;
+    get building(): boolean;
+    get built(): boolean;
+    get meta(): RouteMeta[];
+    get server(): http.Server | undefined;
+    constructor(options?: Options);
+    private _registerRouter;
+    private _buildFramework;
+    private _buildRoutes;
+    /**
+     *
+     * @param options Options to concatenate with current options.
+     * @returns
+     */
+    addOptions(options: Options): BaseApp;
+    addFrameworkOptions(options: FrameworkOptions): BaseApp;
+    addRouters(routers: IRouter[] | IRouter): BaseApp;
+    /**
+     *
+     * @param options
+     * @param mod Module that will create the server (e.g.: require('https'))
+     * @example ```js
+     * const https = require('https');
+     * const server = app.build(HTTPS_SERVER_OPTIONS, https);
+     * server.listen(PORT);
+     * ```
+     */
+    build<T extends http.ServerOptions = http.ServerOptions>(options?: T | null, mod?: {
+        createServer(requestListener?: http.RequestListener): http.Server;
+        createServer(options: T, requestListener?: http.RequestListener | undefined): http.Server;
+    }): http.Server;
+    listen(port?: number, hostname?: string, backlog?: number, listeningListener?: () => void): http.Server;
+    listen(port?: number, hostname?: string, listeningListener?: () => void): http.Server;
+    listen(port?: number, backlog?: number, listeningListener?: () => void): http.Server;
+    listen(port?: number, listeningListener?: () => void): http.Server;
+    listen(path: string, backlog?: number, listeningListener?: () => void): http.Server;
+    listen(path: string, listeningListener?: () => void): http.Server;
+    listen(options: net.ListenOptions, listeningListener?: () => void): http.Server;
+    listen(handle: unknown, backlog?: number, listeningListener?: () => void): http.Server;
+    listen(handle: unknown, listeningListener?: () => void): http.Server;
+    /**
+     * Creates a router and adds it to the application.
+     * @returns The created router
+     */
+    lazyrouter(options?: express.RouterOptions): IRouter;
+    disable(setting: string): BaseApp;
+    disabled(setting: string): boolean;
+    enable(setting: string): BaseApp;
+    enabled(setting: string): boolean;
+    on(event: string, callback: (parent: core.Application) => void): BaseApp;
+    set(setting: string, val?: unknown): BaseApp;
+    get(setting: string): any;
+}