@maschinenlesbar.org/openka-cli
    Preparing search index...

    Interface CorpusDiagnosis

    interface CorpusDiagnosis {
        blobs: string;
        catalog?: {
            catalogued: number;
            misfiled: string[];
            missing_files: string[];
            records: number;
            uncatalogued: string[];
        };
        corpus: string;
        exists: boolean;
        lock: { state: "free" }
        | { holder: string; state: "held" | "stale" };
        orphaned_blobs?: { bytes: number; count: number };
        platform_files: number;
        problems: string[];
        volumes: VolumeReport[];
        warnings: string[];
    }
    Index
    blobs catalog? corpus exists lock orphaned_blobs? platform_files problems volumes warnings
    blobs: string
    catalog?: {
        catalogued: number;
        misfiled: string[];
        missing_files: string[];
        records: number;
        uncatalogued: string[];
    }

    Absent when the catalog or the record files could not be read (problems says why).

    Type Declaration

    • catalogued: number
    • misfiled: string[]

      Records filed by an earlier build under a reference this one reads differently, and so under another paper's id (currentReference, issue #25).

    • missing_files: string[]

      Catalog rows with no record file.

    • records: number
    • uncatalogued: string[]

      Record files with no catalog row.

    corpus: string
    exists: boolean

    False before the first sync: then only the volumes are checked.

    lock: { state: "free" } | { holder: string; state: "held" | "stale" }
    orphaned_blobs?: { bytes: number; count: number }

    Archived documents no record refers to, when asked for (orphanedBlobs): what records removed by hand leave behind. Absent when not asked, or when a record could not be read.

    platform_files: number

    macOS ._* and .DS_Store files anywhere in the corpus and the blob store.

    problems: string[]

    What a sync would refuse, or what makes the corpus incomplete.

    volumes: VolumeReport[]
    warnings: string[]

    Settings
    Member Visibility

    On This Page
    Properties