SCION Microfrontend Platform - v1.6.0
    Preparing search index...

    Interface ApplicationConfig

    Describes how to register an application in the platform.

    interface ApplicationConfig {
        activatorLoadTimeout?: number;
        capabilityActiveCheckDisabled?: boolean;
        exclude?: boolean;
        intentionCheckDisabled?: boolean;
        intentionRegisterApiDisabled?: boolean;
        manifestLoadTimeout?: number;
        manifestUrl: string;
        scopeCheckDisabled?: boolean;
        secondaryOrigin?: string;
        symbolicName: string;
    }
    Index

    Properties

    activatorLoadTimeout? capabilityActiveCheckDisabled? exclude? intentionCheckDisabled? intentionRegisterApiDisabled? manifestLoadTimeout? manifestUrl scopeCheckDisabled? secondaryOrigin? symbolicName

    Properties

    activatorLoadTimeout?: number

    Maximum time (in milliseconds) for this application to signal readiness.

    If activating this application takes longer, the host logs an error and continues startup. If set, overrides the global timeout as configured in MicrofrontendPlatformConfig.activatorLoadTimeout.

    capabilityActiveCheckDisabled?: boolean

    Allows this application to access inactive capabilities.

    Disabling this check is discouraged. Enabled by default.

    exclude?: boolean

    Excludes this micro application from registration, e.g. to not register it in a specific environment.

    intentionCheckDisabled?: boolean

    Allows this application to access public capabilities of other applications without declaring an intention.

    Disabling this check is discouraged. Enabled by default.

    intentionRegisterApiDisabled?: boolean

    Allows this application to register and unregister intentions at runtime.

    Enabling this API is discouraged. Disabled by default.

    manifestLoadTimeout?: number

    Maximum time (in milliseconds) that the host waits until the manifest for this application is loaded.

    If set, overrides the global timeout as configured in MicrofrontendPlatformConfig.manifestLoadTimeout.

    manifestUrl: string

    URL to the application manifest.

    scopeCheckDisabled?: boolean

    Allows this application to access private capabilities of other applications.

    Disabling this check is discouraged. Enabled by default.

    secondaryOrigin?: string

    Specifies an additional origin (in addition to the origin of the application) from which the application is allowed to connect to the platform.

    By default, if not set, the application is allowed to connect from the origin of the manifest URL or the base URL as specified in the manifest file. Setting an additional origin may be necessary if, for example, integrating microfrontends into a rich client, enabling an integrator to bridge messages between clients and host across browser boundaries.

    symbolicName: string

    Unique symbolic name of this micro application.

    The symbolic name must be unique and contain only lowercase alphanumeric characters and hyphens.

    Settings

    Member Visibility

    On This Page

    Properties