mlx-bun library API
    Preparing search index...

    A module's static manifest plus its factory. The manifest is plain data, so documentation generators and hosts read it without loading a model or native code; activate builds the live parts. Modules import only this package, the domain libraries they use, and their own files, never another module, an app or a core-service implementation.

    interface AppModule<R extends CoreServiceName = CoreServiceName> {
        contributes?: readonly (keyof ExtensionPoints)[];
        id: string;
        jobs?: readonly JobRunnerSpec[];
        panel?: PanelSpec;
        placement?: "model" | "app";
        requires: readonly R[];
        routes?: readonly RouteSpec[];
        sockets?: readonly SocketSpec[];
        storage?: readonly StorageEntrySpec[];
        summary: string;
        title: string;
        verbs?: readonly CliVerbSpec[];
        activate(context: ModuleContext<R>): ModuleRuntime | Promise<ModuleRuntime>;
    }

    Type Parameters

    Index
    contributes?: readonly (keyof ExtensionPoints)[]

    Extension points the module registers to (needs registry in requires).

    id: string

    Lowercase kebab-case; the route prefix, panel path and event prefix.

    jobs?: readonly JobRunnerSpec[]
    panel?: PanelSpec
    placement?: "model" | "app"

    Where a host that keeps its persistent services apart from its model host activates the module: app beside the jobs, the served model's wire and the serving host's residency, model with the model host. Default app for a module that requires jobs, else model.

    requires: readonly R[]
    routes?: readonly RouteSpec[]
    sockets?: readonly SocketSpec[]
    storage?: readonly StorageEntrySpec[]
    summary: string
    title: string
    verbs?: readonly CliVerbSpec[]