Interface FeatureAppLoaderProps<TConfig>

Type Parameters

  • TConfig = unknown

Hierarchy

  • FeatureAppDescriptor
    • FeatureAppLoaderProps

Properties

baseUrl? beforeCreate? children? config? css? done? moduleType? onError? serverModuleType? serverSrc? src

Properties

Optional Readonly baseUrl

baseUrl?: string

The absolute or relative base URL of the Feature App's assets and/or BFF.

Optional Readonly beforeCreate

beforeCreate?: ((env: FeatureAppEnvironment<FeatureServices, TConfig>) => void)

Type declaration

    • (env: FeatureAppEnvironment<FeatureServices, TConfig>): void

    • A callback that is called before the Feature App is created.

      Parameters

      • env: FeatureAppEnvironment<FeatureServices, TConfig>

      Returns void

Optional Readonly children

children?: ((params: CustomFeatureAppRenderingParams) => ReactNode)

Type declaration

Optional Readonly config

config?: TConfig

A config object that is passed to the Feature App's create method.

Optional Readonly css

css?: Css[]

A list of stylesheets to be added to the document. If baseUrl is specified, it will be prepended, unless Css.href is an absolute URL.

Optional Readonly done

done?: ((result?: unknown) => void)

Type declaration

    • (result?: unknown): void

    • A callback that is passed to the Feature App's create method. A short-lived Feature App can call this function when it has completed its task. The Integrator (or parent Feature App) can then decide to e.g. unmount the Feature App.

      Optionally, the Feature App can pass a result into the done callback. The type/structure of the result must be agreed between the Integrator (or parent Feature App) and the Feature App.

      Parameters

      • Optional result: unknown

      Returns void

Optional Readonly moduleType

moduleType?: string

The module type of the Feature App's client module bundle. It is passed to the module loader that was provided as part of FeatureAppManagerOptions.moduleLoader.

Optional Readonly onError

onError?: ((error: unknown) => void)

Type declaration

    • (error: unknown): void

    • Parameters

      • error: unknown

      Returns void

Optional Readonly serverModuleType

serverModuleType?: string

The module type of the Feature App's server module bundle. It is passed to the module loader that was provided as part of FeatureAppManagerOptions.moduleLoader.

Optional Readonly serverSrc

serverSrc?: string

The URL of the Feature App's server module bundle. If baseUrl is specified, it will be prepended, unless serverSrc is an absolute URL. Either baseUrl or serverSrc must be an absolute URL.

Readonly src

src: string

The URL of the Feature App's client module bundle. If baseUrl is specified, it will be prepended, unless src is an absolute URL.

Settings

Member Visibility

Theme

Generated using TypeDoc