SCION Microfrontend Platform - v2.0.0
    Preparing search index...

    Interface HostConfig

    Configures the interaction of the host application with the platform.

    As with micro applications, you can provide a manifest for the host, allowing the host to contribute capabilities and declare intentions.

    interface HostConfig {
        capabilityActiveCheckDisabled?: boolean;
        intentionCheckDisabled?: boolean;
        intentionRegisterApiDisabled?: boolean;
        manifest?: string | Manifest;
        messageDeliveryTimeout?: number;
        scopeCheckDisabled?: boolean;
        symbolicName?: string;
    }
    Index

    Properties

    capabilityActiveCheckDisabled? intentionCheckDisabled? intentionRegisterApiDisabled? manifest? messageDeliveryTimeout? scopeCheckDisabled? symbolicName?

    Properties

    capabilityActiveCheckDisabled?: boolean

    Allows the host to access inactive capabilities.

    Disabling this check is discouraged. Enabled by default.

    intentionCheckDisabled?: boolean

    Allows the host to access public capabilities of other applications without declaring an intention.

    Disabling this check is discouraged. Enabled by default.

    intentionRegisterApiDisabled?: boolean

    Allows the host to register and unregister intentions at runtime.

    Enabling this API is discouraged. Disabled by default.

    manifest?: string | Manifest

    The manifest of the host.

    The manifest can be passed either as an object literal or specified as a URL to be loaded over the network. Providing a manifest lets the host contribute capabilities or declare intentions.

    messageDeliveryTimeout?: number

    Maximum time (in milliseconds) that the platform waits to receive dispatch confirmation for messages sent by the host until rejecting the publishing Promise. By default, a timeout of 10s is used.

    scopeCheckDisabled?: boolean

    Allows the host to access private capabilities of other applications.

    Disabling this check is discouraged. Enabled by default.

    symbolicName?: string

    Symbolic name of the host. If not set, 'host' is used as the symbolic name of the host.

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

    Settings

    Member Visibility

    On This Page

    Properties