Interface ReadStageOutput

Output of the read stage: inventory of all available artifacts.

interface ReadStageOutput {
    artifacts: readonly ArtifactFile[];
    hasDocuments: boolean;
    availableFiles: ReadonlySet<string>;
}

Properties

artifacts: readonly ArtifactFile[]

All markdown artifacts found in the subfolder.

hasDocuments: boolean

Whether a documents/ subdirectory with per-document analyses exists.

availableFiles: ReadonlySet<string>

Set of filenames available (for Reader Guide filtering).