FynMesh API
    Preparing search index...

    Type Alias FederationPluginOptions

    Configuration options for the Module Federation plugin

    type FederationPluginOptions = {
        debugging?: boolean;
        emitFederationJson?: boolean;
        emitFederationMeta?: (
            federationInfo: FederationInfo,
            runtime: FederationRuntime,
            context: PluginContext,
            bundle: OutputBundle,
        ) => void | Promise<void>;
        emitMeta?: (
            runtime: FederationRuntime,
            context: PluginContext,
            bundle: OutputBundle,
        ) => void | Promise<void>;
        enrichManifest?: (
            baseManifest: any,
            runtime: FederationRuntime,
            context: PluginContext,
        ) => any | Promise<any>;
        entry?: { footer?: string; header?: string };
        exposes?: Record<string, string>;
        filename: string;
        name: string;
        renderDynamicImport?: DynamicImportConfigOptions;
        shared?: Record<string, SharedConfig>;
        shareScope?: string;
        version?: string;
    }
    Index
    debugging? emitFederationJson? emitFederationMeta? emitMeta? enrichManifest? entry? exposes? filename name renderDynamicImport? shared? shareScope? version?
    debugging?: boolean

    Whether to enable debug logging and output

    emitFederationJson?: boolean

    Whether to emit federation info as JSON file (defaults to true)

    emitFederationMeta?: (
        federationInfo: FederationInfo,
        runtime: FederationRuntime,
        context: PluginContext,
        bundle: OutputBundle,
    ) => void | Promise<void>

    Custom federation metadata emission callback

    emitMeta?: (
        runtime: FederationRuntime,
        context: PluginContext,
        bundle: OutputBundle,
    ) => void | Promise<void>

    Custom metadata emission callback

    enrichManifest?: (
        baseManifest: any,
        runtime: FederationRuntime,
        context: PluginContext,
    ) => any | Promise<any>

    Callback to enrich the base manifest with additional data. Called during the load() hook with base manifest data (exposes, shared, dynamicImports). The enriched manifest will be embedded in the entry file and emitted as fynapp.manifest.json.

    Type Declaration

      • (
            baseManifest: any,
            runtime: FederationRuntime,
            context: PluginContext,
        ): any | Promise<any>

      • Parameters

        • baseManifest: any

          Base manifest with exposes, shared, and dynamic imports

        • runtime: FederationRuntime

          Federation runtime with collected data

        • context: PluginContext

          Rollup plugin context

        Returns any | Promise<any>

        Enriched manifest object

    Optionalentry

    entry?: { footer?: string; header?: string }

    configuration for the federation entry file

    Type Declaration

    • Optionalfooter?: string

      Code to insert at the end of the entry file

    • Optionalheader?: string

      Code to insert at the beginning of the entry file

    exposes?: Record<string, string>

    Modules to be exposed to other federation containers

    filename: string

    Output filename for the federation container. You must also add filename to the input config array

    name: string

    Name of this federation container

    renderDynamicImport?: DynamicImportConfigOptions

    Dynamic import rendering for specific import types

    shared?: Record<string, SharedConfig>

    Modules to be shared with other federation containers

    shareScope?: string

    Namespace for sharing modules

    version?: string

    Version of this federation container

    Settings
    Member Visibility

    On This Page
    Properties