docx-validate
    Preparing search index...

    Type Alias ValidationMetadata

    Execution metadata for one validation run (plan § 1, tasks 10-11). Answers "what actually ran", so a caller can tell a complete run from a partial one: a partial run is still valid when its selected checks passed, but omittedChecks is non-empty and the caller is expected to say so.

    Every field is optional so a validator that knows nothing about modes can still return a ValidationResult unchanged.

    type ValidationMetadata = {
        deadline?: { budgetMs: number; notRun: readonly string[] };
        executedChecks?: readonly string[];
        omittedChecks?: readonly string[];
        profile?: Profile;
        schemaCompleted?: boolean;
        wordVerification?: WordVerificationMetadata;
    }
    Index
    deadline? executedChecks? omittedChecks? profile? schemaCompleted? wordVerification?
    deadline?: { budgetMs: number; notRun: readonly string[] }

    Present when the caller gave the run a deadlineMs (#630): the budget, and the steps it stopped, in the order they were stopped. An empty notRun means every step ran. A non-empty one comes with one error-severity validation-deadline finding.

    executedChecks?: readonly string[]

    Check ids this run covered, in registry order.

    omittedChecks?: readonly string[]

    Applicable check ids the selection left out. Empty for a complete run.

    profile?: Profile

    The profile the run was executed under.

    schemaCompleted?: boolean

    True only when every schema-eligible part was validated and no schema failed to load. False when schema validation never started, stopped early, or the engine could not compile a schema. Always false for a partial run, and for a DOCX/DOCM under word-valid, which judges the package by structural Word checks and compiles no schema. A PPTX walks its schemas under every profile, word-valid included (#340).

    wordVerification?: WordVerificationMetadata

    Present when real-Word verification ran.

    Settings
    Member Visibility

    On This Page
    Properties