@framing/ng-core/src/framing-ng-module.d.ts

import { ModuleWithProviders, NgModule, Provider, Type } from '@angular/core';
import { Route } from '@angular/router';
import { Framer } from './framer';
import { FramingRootComponentConfig } from './framing-root-component-config';
import { FramingRouteConfig } from './framing-route-config';
/**
 *
 */
export declare class FramingNgModule {
    private static _nextId;
    private _ngModule;
    private _root;
    private _rootComponent;
    private _rootComponentConfig;
    private _routes;
    private _routeConfig;
    static readonly defaultPathMatch: string;
    ngModule(ngModule?: NgModule): FramingNgModule;
    bootstrap(bootstrap: any[]): FramingNgModule;
    /**
     * Add a child route. Adds to '' route by default
     */
    child(child: Route): FramingNgModule;
    child(child: Route, parent: Route): FramingNgModule;
    child(child: Route, parent: Route[]): FramingNgModule;
    /**
     * Adds to imports
     * Adds to route
     */
    children(children: Route[]): FramingNgModule;
    children(children: Route[], parent: Route): FramingNgModule;
    children(children: Route[], parent: Route[]): FramingNgModule;
    /**
     * Adds as component on route
     */
    component(component: Type<any>): FramingNgModule;
    component(component: Type<any>, route: Route): FramingNgModule;
    component(component: Type<any>, route: Route[]): FramingNgModule;
    /**
     * Adds as component on route
     * Adds component to declarations
     */
    componentAndDeclare(component: Type<any>): FramingNgModule;
    componentAndDeclare(component: Type<any>, route: Route): FramingNgModule;
    componentAndDeclare(component: Type<any>, route: Route[]): FramingNgModule;
    /**
     * Adds as component on route
     * Adds component to declarations
     */
    componentAndDeclaration(component: Type<any>): FramingNgModule;
    componentAndDeclaration(component: Type<any>, route: Route): FramingNgModule;
    componentAndDeclaration(component: Type<any>, route: Route[]): FramingNgModule;
    /**
     * Adds containers to route data
     * Adds container components to exports and declarations
     */
    container(container: string, components: Type<any> | Type<any>[]): FramingNgModule;
    container(container: string, components: Type<any> | Type<any>[], route: Route): FramingNgModule;
    container(container: string, components: Type<any> | Type<any>[], route: Route[]): FramingNgModule;
    /**
     * Adds containers to route data
     * Adds container components to exports and declarations
     */
    containers(containers: {
        [key: string]: Type<any> | Type<any>[];
    }): FramingNgModule;
    containers(containers: {
        [key: string]: Type<any> | Type<any>[];
    }, route: Route): FramingNgModule;
    containers(containers: {
        [key: string]: Type<any> | Type<any>[];
    }, route: Route[]): FramingNgModule;
    /**
     * Method for appending data to route
     */
    datum(key: string, datum: any): FramingNgModule;
    datum(key: string, datum: any, route: Route): FramingNgModule;
    datum(key: string, datum: any, route: Route[]): FramingNgModule;
    /**
     * Methods for appending data to route
     */
    data(data: {
        [key: string]: any;
    }): FramingNgModule;
    data(data: {
        [key: string]: any;
    }, route: Route): FramingNgModule;
    data(data: {
        [key: string]: any;
    }, route: Route[]): FramingNgModule;
    /**
     * Method for appending data resolve to route
     */
    resolve(key: string, resolve: string | Type<any>): FramingNgModule;
    resolve(key: string, resolve: string | Type<any>, route: Route): FramingNgModule;
    resolve(key: string, resolve: string | Type<any>, route: Route[]): FramingNgModule;
    /**
     * Method for appending data resolve to route
     */
    resolves(resolves: {
        [key: string]: string | Type<any>;
    }): FramingNgModule;
    resolves(resolves: {
        [key: string]: string | Type<any>;
    }, route: Route): FramingNgModule;
    resolves(resolves: {
        [key: string]: string | Type<any>;
    }, route: Route[]): FramingNgModule;
    declare(declaration: Type<any> | Type<any>[]): FramingNgModule;
    declaration(declaration: Type<any> | Type<any>[]): FramingNgModule;
    declarations(declarations: Type<any>[]): FramingNgModule;
    declareAndExport(declaration: Type<any> | Type<any>[]): FramingNgModule;
    declarationAndExport(declaration: Type<any> | Type<any>[]): FramingNgModule;
    declarationsAndExports(declarations: Type<any>[]): FramingNgModule;
    declareAndEntryComponent(declaration: Type<any> | Type<any>[]): FramingNgModule;
    declarationAndEntryComponent(declaration: Type<any> | Type<any>[]): FramingNgModule;
    declarationsAndEntryComponents(declarations: Type<any>[]): FramingNgModule;
    entryComponent(entryComponent: Type<any> | Type<any>[]): FramingNgModule;
    entryComponents(entryComponents: Type<any>[]): FramingNgModule;
    export(e: Type<any> | Type<any>[]): FramingNgModule;
    exports(exports: Type<any>[]): FramingNgModule;
    import(i: Type<any> | Type<any>[] | ModuleWithProviders | ModuleWithProviders): FramingNgModule;
    imports(imports: (Type<any> | ModuleWithProviders)[]): FramingNgModule;
    importAndExport(m: Type<any> | Type<any>[]): FramingNgModule;
    importsAndExports(modules: Type<any>[]): FramingNgModule;
    provide(provider: Provider | Provider[] | Type<any> | Type<any>[]): FramingNgModule;
    provider(provider: Provider | Provider[] | Type<any> | Type<any>[]): FramingNgModule;
    providers(providers: Provider[] | Type<any>[]): FramingNgModule;
    /**
     * Adds component to bootstrap
     * Defaults route to path '', pathMatch: 'full'
     */
    root(rootComponent?: Type<any>, config?: FramingRootComponentConfig): FramingNgModule;
    /**
     * Creates Routes array with single route
     * Adds RouterModule.forRoot(routes) or RouterModule.forChild(routes) to imports
     * Adds all resolve services as providers
     */
    route(route?: Route, config?: FramingRouteConfig): FramingNgModule;
    routes(routes: Route[], config?: FramingRouteConfig): FramingNgModule;
    frameRoute(route: Route, ...framers: Framer<any, any>[]): FramingNgModule;
    frameRoute(route: Route[], ...framers: Framer<any, any>[]): FramingNgModule;
    /**
     * Returns the route if it exists.
     */
    getRoute(route?: Route, array?: Route[]): Route;
    /**
     * Returns the route. Creates it if it does not exist.
     */
    getOrAddRoute(route?: Route, array?: Route[]): Route;
    /**
     * Run framers.
     */
    frame(...framers: Framer<any, any>[]): FramingNgModule;
    use(...framers: Framer<any, any>[]): FramingNgModule;
    /**
     * Builds @NgModule() config in the following order:
     * - Route framers
     * - Root
     * - Route
     */
    build(): NgModule;
    private inspectModule();
    private inspectRoute(route);
    private buildRoot();
    private buildFramers(framers, route?);
    private buildFramer(framer, route);
    /**
     * Builds framers that were manually added to route data.
     */
    private buildRouteFramers(routes);
    private buildContainers(routes);
    private buildRoute();
    private getOrAddRouteOverload(route);
}