mlx-bun library API
    Preparing search index...

    Interface CompanionInfoOptions

    interface CompanionInfoOptions {
        endpoints: readonly string[];
        modelId: string;
        models: Pick<ModelHost, "stats">;
        name: string;
        startedAt?: number;
        version: string;
        counters(): | Readonly<Record<string, string | number | boolean | null>>
        | undefined;
    }
    Index
    endpoints modelId models name startedAt? version
    counters
    endpoints: readonly string[]
    modelId: string

    The served checkpoint.

    models: Pick<ModelHost, "stats">
    name: string

    The /v1 document's name, version and advertised endpoints (METHOD /path).

    startedAt?: number
    version: string

    • The transcription module's live counters (requests, sessions), by LoadedModules.status.

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

    Settings
    Member Visibility

    On This Page
    Properties
    Methods