Describes how to register an application in the platform.

Hierarchy

  • ApplicationConfig

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.

exclude?: boolean

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

intentionCheckDisabled?: boolean

Controls whether this micro application can interact with the capabilities of other apps without having to declare respective intentions.

By default, intention check is enabled. Disabling intention check is strongly discouraged.

intentionRegisterApiDisabled?: boolean

Controls whether this micro application can register and unregister intentions dynamically at runtime.

By default, this API is disabled. Enabling this API is strongly discouraged.

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

Controls whether this micro application can interact with private capabilities of other micro applications.

By default, scope check is enabled. Disabling scope check is strongly discouraged.

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.

Generated using TypeDoc