FynMesh API
    Preparing search index...

    Interface FynUnit

    Standardized interface for FynMesh execution units

    FynUnit is the core contract for any executable unit in FynMesh. It can be implemented by plain objects, functions (wrapped by kernel), or class instances.

    export const main: FynUnit = {
      execute(runtime) { return { type: 'component', component: MyComponent }; }
    };

    Example: Function (kernel wraps as { execute: fn })

    export const main = (runtime: FynUnitRuntime) => { ... };

    export const main = useMiddleware(
      [{ mw: import('...'), config: {...} }],
      { execute(runtime) { ... } }
    );
    interface FynUnit {
        __middlewareMeta?: MiddlewareDeclaration<unknown>[];
        execute(runtime: FynUnitRuntime): any;
        initialize?(
            runtime: FynUnitRuntime,
        ):
            | Promise<{ mode?: string; status: string }>
            | { mode?: string; status: string };
        resume?(runtime: FynUnitRuntime): void | Promise<void>;
        shutdown?(runtime: FynUnitRuntime): void | Promise<void>;
        suspend?(runtime: FynUnitRuntime): void | Promise<void>;
        [key: string]: any;
    }

    Indexable

    • [key: string]: any
    Index
    __middlewareMeta?
    execute initialize? resume? shutdown? suspend?

    Optional__middlewareMeta

    __middlewareMeta?: MiddlewareDeclaration<unknown>[]

    • Do your actual work - called when middleware is ready. Returns any value - middleware defines contract.

      Parameters

      Returns any

    • Tell middleware what you need - called first to determine readiness

      Parameters

      Returns Promise<{ mode?: string; status: string }> | { mode?: string; status: string }

    • Resume a suspended FynApp.

      Parameters

      Returns void | Promise<void>

    • Graceful shutdown - called when FynApp is being unloaded. Clean up resources here.

      Parameters

      Returns void | Promise<void>

    • Pause a mounted FynApp running in the background (e.g. stop timers, unsubscribe). Kept in the registry; resume() restores it.

      Parameters

      Returns void | Promise<void>

    Settings
    Member Visibility

    On This Page
    Properties
    Methods