feat(all): add optional result parameter to done callback (#701)

feature-hub · Jan 31, 2022 · 86feace · 86feace
1 parent 64a6f32
commit 86feace
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 4 deletions.
diff --git a/packages/core/src/feature-app-manager.ts b/packages/core/src/feature-app-manager.ts
@@ -45,8 +45,12 @@ export interface FeatureAppEnvironment<
    * 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.
    */
-  readonly done?: () => void;
+  readonly done?: (result?: unknown) => void;
 }
 
 export interface FeatureAppDefinition<
@@ -118,8 +122,12 @@ export interface FeatureAppScopeOptions<
    * 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.
    */
-  readonly done?: () => void;
+  readonly done?: (result?: unknown) => void;
 }
 
 export interface FeatureAppManagerOptions {

diff --git a/packages/react/src/feature-app-loader.tsx b/packages/react/src/feature-app-loader.tsx
@@ -88,8 +88,12 @@ export interface FeatureAppLoaderProps<TConfig = unknown> {
    * 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.
    */
-  readonly done?: () => void;
+  readonly done?: (result?: unknown) => void;
 
   readonly onError?: (error: Error) => void;
 

diff --git a/packages/react/src/internal/internal-feature-app-container.tsx b/packages/react/src/internal/internal-feature-app-container.tsx
@@ -76,8 +76,12 @@ export interface BaseFeatureAppContainerProps<
    * 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.
    */
-  readonly done?: () => void;
+  readonly done?: (result?: unknown) => void;
 
   readonly onError?: (error: Error) => void;