Interface ISetupProperties

A copy of IComponentsManagerBuilderOptions, with all fields optional.

interface ISetupProperties {
    configLoader?: ((registry) => Promise<void>);
    constructionStrategy?: IConstructionStrategy<any>;
    dumpErrorState?: boolean;
    logLevel?: LogLevel;
    mainModulePath?: string;
    moduleLoader?: ((registry) => Promise<void>);
    moduleState?: IModuleState;
}

Hierarchy

  • ISetupProperties

    Properties

    configLoader? constructionStrategy? dumpErrorState? logLevel? mainModulePath? moduleLoader? moduleState?

    Properties

    Optional configLoader

    configLoader?: ((registry) => Promise<void>)

    Callback for registering configurations. Defaults to no config registrations.

    Type declaration

      • (registry): Promise<void>

      • Parameters

        • registry: ConfigRegistry

          A registry that accepts configuration registrations.

        Returns Promise<void>

    Optional constructionStrategy

    constructionStrategy?: IConstructionStrategy<any>

    A strategy for constructing instances. Defaults to ConstructionStrategyCommonJs.

    Optional dumpErrorState

    dumpErrorState?: boolean

    If the error state should be dumped into componentsjs-error-state.json after failed instantiations. Defaults to false.

    Optional logLevel

    logLevel?: LogLevel

    The logging level. Defaults to 'warn'.

    Optional mainModulePath

    mainModulePath?: string

    Absolute path to the package root from which module resolution should start.

    Optional moduleLoader

    moduleLoader?: ((registry) => Promise<void>)

    Callback for registering components and modules. Defaults to an invocation of ComponentRegistry.registerAvailableModules.

    Type declaration

      • (registry): Promise<void>

      • Parameters

        • registry: ComponentRegistry

          A registry that accept component and module registrations.

        Returns Promise<void>

    Optional moduleState

    moduleState?: IModuleState

    The module state. Defaults to a newly created instances on the mainModulePath.

    Settings

    Member Visibility

    Theme

    On This Page

    configLoaderconstructionStrategydumpErrorStatelogLevelmainModulePathmoduleLoadermoduleState