Interface FeatureAppScopeOptions<TFeatureServices, TConfig>

Type Parameters

Hierarchy

  • FeatureAppScopeOptions

Properties

baseUrl? beforeCreate? config? done? featureAppName? parentFeatureApp?

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<TFeatureServices, TConfig>) => void)

Type declaration

Optional Readonly config

config?: TConfig

A config object that is intended for a specific Feature App instance.

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 featureAppName

featureAppName?: string

The Feature App's name. In contrast to the featureAppId, the name must not be unique. It can be used by required Feature Services for display purposes, logging, looking up Feature App configuration meta data, etc.

Optional Readonly parentFeatureApp

parentFeatureApp?: FeatureAppDescriptor

If the Feature App is created in the context of another Feature App, the parentFeatureApp property should be populated accordingly. This allows the integrator to collect information about "Feature App in Feature App" usage.

Settings

Member Visibility

Theme

Generated using TypeDoc