FynMesh API
    Preparing search index...

    Interface MiddlewareKernelApi

    Kernel API added by the middleware add-on.

    interface MiddlewareKernelApi {
        getMiddleware(
            name: string,
            provider?: string,
            opts?: MiddlewareLookupOptions,
        ): FynAppMiddlewareReg;
        getMiddlewareRegistry(
            scope: { region: string } | "global",
        ): MiddlewareStateRegistry;
        registerMiddleware(meta: FynAppMiddlewareReg): void;
        signalMiddlewareReady(
            cc: FynAppMiddlewareCallContext,
            detail?: { name?: string; share?: any; status?: string },
        ): Promise<void>;
    }
    Index
    getMiddleware getMiddlewareRegistry registerMiddleware signalMiddlewareReady

    • Get middleware by name and provider

      Parameters

      • name: string

        middleware name

      • Optionalprovider: string

        provider FynApp name (optional, triggers fallback search if not provided)

      • Optionalopts: MiddlewareLookupOptions

        lookup options; version is the semver range the consumer asked for. Omitting it resolves to the default version, as it always has.

      Returns FynAppMiddlewareReg

    • Get middleware state registry for global or region scope

      Parameters

      • scope: { region: string } | "global"

        either "global" or { region: string }

      Returns MiddlewareStateRegistry

    • Register a middleware implementation (called automatically during FynApp loading)

      Parameters

      Returns void

    • Programmatic API for middlewares to signal readiness to the kernel without emitting DOM events.

      • Optionally pass a share object to be provided to waiting consumers via cc.runtime.share

      Parameters

      Returns Promise<void>

    Settings
    Member Visibility

    On This Page
    Methods