Interface ExtractSummary

Summary of an extract run, in the shape emitted by --json.

interface ExtractSummary {
    command: "extract";
    success: boolean;
    dryRun: boolean;
    filesProcessed: number;
    filesModified: string[];
    imagesExtracted: number;
    imagesCreated: string[];
    errors: string[];
    warnings: string[];
}

Properties

command: "extract"

Always "extract", so JSON consumers can identify the command

success: boolean

Whether the run completed without errors

dryRun: boolean

Whether this was a dry run, so no files were touched

filesProcessed: number

Number of markdown files examined

filesModified: string[]

Markdown files whose content was rewritten (empty in a dry run)

imagesExtracted: number

Number of inline data URIs rewritten to file links

imagesCreated: string[]

Image files created (empty in a dry run)

errors: string[]

Error messages, one per failure

warnings: string[]

Warning messages