Comunica
    Preparing search index...

    Interface ISetupProperties

    A copy of IComponentsManagerBuilderOptions, with all fields optional.

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

    Hierarchy (View Summary)

    Index

    Properties

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

    Callback for registering configurations. Defaults to no config registrations.

    Type declaration

      • (registry: ConfigRegistry): Promise<void>
      • Parameters

        • registry: ConfigRegistry

          A registry that accepts configuration registrations.

        Returns Promise<void>

    constructionStrategy?: IConstructionStrategy<any>

    A strategy for constructing instances. Defaults to ConstructionStrategyCommonJs.

    dumpErrorState?: boolean

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

    logLevel?: LogLevel

    The logging level. Defaults to 'warn'.

    mainModulePath?: string

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

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

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

    Type declaration

      • (registry: ComponentRegistry): Promise<void>
      • Parameters

        • registry: ComponentRegistry

          A registry that accept component and module registrations.

        Returns Promise<void>

    moduleState?: IModuleState

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