ksmf/types/src/plugin/Module.d.ts

Modular Microframework for create minimalistic CLI/Web application or REST API

export = Module;
/**
 * @author      Antonio Membrides Espinosa
 * @email       tonykssa@gmail.com
 * @date        07/03/2020
 * @copyright   Copyright (c) 2020-2030
 * @license     GPL
 * @version     1.4
 **/
declare class Module {
    /**
     * @description initialize module
     * @param {Object} payload
     * @param {Object} [payload.app]
     * @param {Object} [payload.web]
     * @param {Object} [payload.opt]
     */
    constructor(payload: {
        app?: any;
        web?: any;
        opt?: any;
    });
    /**
     * @type {Object|null}
     */
    helper: any | null;
    /**
     * @type {Object|null}
     */
    app: any | null;
    /**
     * @type {Console|null}
     */
    logger: Console | null;
    /**
     * @type {String|null}
     */
    type: string | null;
    /**
     * @description initialize module
     * @param {Object} payload
     * @param {Object} [payload.app]
     * @param {Object} [payload.web]
     * @param {Object} [payload.drv]
     * @param {Object} [payload.opt]
     * @param {String} [payload.opt.name]
     * @param {String} [payload.opt.prefix]
     * @param {Array} [payload.opt.routes]
     * @param {Boolean} [payload.opt.rest]
     * @param {Boolean} [payload.rest]
     * @param {Object} [payload.server]
     * @param {Object} [payload.routes]
     * @param {Object} [payload.prefix]
     * @param {Object} [payload.middleware]
     * @returns {Module} self
     */
    configure(payload: {
        app?: any;
        web?: any;
        drv?: any;
        opt?: {
            name?: string;
            prefix?: string;
            routes?: any[];
            rest?: boolean;
        };
        rest?: boolean;
        server?: any;
        routes?: any;
        prefix?: any;
        middleware?: any;
    }): Module;
    opt: any;
    web: any;
    drv: any;
    name: any;
    prefix: any;
    rest: any;
    routes: any;
    middleware: any;
    /**
     * @description implement template method pattern
     */
    init(): void;
    /**
     * @description allow customized application initialization by module
     */
    initApp(): void;
    /**
     * @description allow customized config initialization by module
     */
    initConfig(): void;
    /**
     * @description allow customized routes initialization by module
     */
    initRoutes(): void;
    /**
     * @description allow customized web routes initialization by module
     * @param {Object} opt
     * @param {String} [opt.route]
     * @param {String} [opt.action]
     * @param {String} [opt.name]
     * @param {String} [opt.controller]
     * @param {String} [opt.method]
     * @param {String} [opt.path]
     */
    initRouterWeb(opt: {
        route?: string;
        action?: string;
        name?: string;
        controller?: string;
        method?: string;
        path?: string;
    }): Promise<void>;
    /**
     * @description allow customized REST routes initialization by module
     * @param {Object} opt
     * @param {String} [opt.route]
     * @param {String} [opt.name]
     * @param {String} [opt.controller]
     * @param {String} [opt.path]
     */
    initRouterREST(opt: {
        route?: string;
        name?: string;
        controller?: string;
        path?: string;
    }): Promise<any>;
    /**
     * @description get IoC locator options
     * @param {Object} opt
     * @param {String} [opt.route]
     * @param {String} [opt.name]
     * @param {String} [opt.action]
     * @param {String} [opt.controller]
     * @param {String} [opt.path]
     * @param {Object} [opt.params]
     * @param {Object} [opt.method]
     * @param {Object} [opt.options]
     * @param {Object} [opt.delegate]
     * @param {Function} [opt.handler]
     * @param {Object} [opt.dependency]
     * @param {Boolean} [opt.strict]
     * @returns {Object} locator
     */
    getLocator(opt: {
        route?: string;
        name?: string;
        action?: string;
        controller?: string;
        path?: string;
        params?: any;
        method?: any;
        options?: any;
        delegate?: any;
        handler?: Function;
        dependency?: any;
        strict?: boolean;
    }): any;
    /**
     * @description get a controller instance
     * @param {Object} locator
     * @returns {Promise<Object>} controller
     */
    getController(locator: any): Promise<any>;
    /**
     * @description get middleware list by controller
     * @param {Object} controller
     * @param {Object} opt
     * @param {String} action
     * @returns {Array} middlewares
     */
    getMiddlewareList(controller: any, opt: any, action?: string): any[];
    /**
     * @description initialize module middleware list
     * @param {Object} middleware
     * @returns {Object} middleware
     */
    initMiddlewareList(middleware: any, actions?: any): any;
}