Interface FeatureAppEnvironment<TFeatureServices, TConfig>

Type Parameters

Hierarchy

Properties

baseUrl config done? featureAppId featureAppName? featureServices

Properties

Readonly baseUrl

baseUrl: undefined | string

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

Readonly config

config: undefined | TConfig

A config object that is provided by the integrator.

Optional Readonly done

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

Type declaration

    • (result?: unknown): void

    • If this callback is defined, 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

Readonly featureAppId

featureAppId: string

The ID that the integrator (or parent Feature App) has assigned to the Feature App instance.

Optional Readonly featureAppName

featureAppName?: string

The name that the integrator (or parent Feature App) might have assigned to the Feature App.

Readonly featureServices

featureServices: TFeatureServices

An object of required Feature Services that are semver-compatible with the declared dependencies in the Feature App definition.

Settings

Member Visibility

Theme

Generated using TypeDoc