mlx-bun library API
    Preparing search index...

    Interface LoadedModules

    The activated modules and everything they declared, for the host to serve, dispatch and create.

    interface LoadedModules {
        jobs: ReadonlyMap<string, RegisteredJob>;
        modules: readonly AppModule<keyof CoreServices>[];
        registry: Pick<Registry, "list" | "onChange">;
        routes: readonly MountedRoute[];
        sockets: readonly MountedSocket[];
        storage: readonly StorageRegistration[];
        verbs: ReadonlyMap<string, RegisteredVerb>;
        status(
            moduleId: string,
        ): Readonly<Record<string, string | number | boolean | null>> | undefined;
        stop(): Promise<void>;
    }
    Index
    jobs modules registry routes sockets storage verbs
    status stop
    jobs: ReadonlyMap<string, RegisteredJob>

    Keyed by job kind.

    modules: readonly AppModule<keyof CoreServices>[]
    registry: Pick<Registry, "list" | "onChange">
    routes: readonly MountedRoute[]

    Full request paths (/api/<id>/..., or the path itself for mount: "root").

    sockets: readonly MountedSocket[]
    storage: readonly StorageRegistration[]
    verbs: ReadonlyMap<string, RegisteredVerb>

    Keyed by verb name.

    • A module's live counters (ModuleRuntime.status); undefined for a module that reports none or has stopped.

      Parameters

      • moduleId: string

      Returns Readonly<Record<string, string | number | boolean | null>> | undefined

    • Aborts every module, disposes them in reverse order and drops their registrations. Idempotent; rejects with every disposal failure.

      Returns Promise<void>

    Settings
    Member Visibility

    On This Page
    Properties
    Methods