docx-validate
    Preparing search index...

    Type Alias ValidateOptions

    type ValidateOptions = {
        checks?: readonly string[];
        deadlineMs?: number;
        profile?: Profile;
        quick?: boolean;
        schemasDir?: string;
        strict?: boolean;
        suffix?: string;
        verifyWord?: boolean;
        wordVerifier?: WordVerifier;
        xsdValidator?: XsdValidator;
    }
    Index
    checks? deadlineMs? profile? quick? schemasDir? strict? suffix? verifyWord? wordVerifier? xsdValidator?
    checks?: readonly string[]

    Run these check ids or group names, plus their prerequisites.

    deadlineMs?: number

    Wall-clock budget of the whole run, in milliseconds, counted from run(), the write of the bytes to a temporary file included (#630). See the path entrypoint's deadlineMs.

    profile?: Profile

    Validation profile. Omitted means the per-format default ("word-valid" for .docx/.docm, "lenient" otherwise). See "./lib/mode-policy" for how a request becomes a mode.

    quick?: boolean

    Run the common-defect check preset and disclose the checks it omits.

    schemasDir?: string

    Override the bundled XSD schemas directory. Defaults to the src/scripts/office/schemas/ tree shipped with the package.

    strict?: boolean

    Shorthand for profile: "strict".

    suffix?: string

    File-extension override. Detected from the DOCX magic bytes when omitted; specify when the bytes are known to be a different supported suffix (e.g. .pptx, .docm).

    verifyWord?: boolean

    Also ask Microsoft Word to open the exact bytes.

    wordVerifier?: WordVerifier

    Override the real-Word verifier. Defaults to verifyInWord.

    xsdValidator?: XsdValidator

    Override the XSD engine. When omitted, BaseSchemaValidator uses its default wasm-backed validator (the libxmljs2 legacy path was retired with the libxml2-wasm cutover — the native addon cannot build on Node 26).

    Settings
    Member Visibility

    On This Page
    Properties