epubcheck-ts
    Preparing search index...

    Interface ValidationContext

    Internal validation context passed through the validation pipeline

    interface ValidationContext {
        contentFeatures?: {
            dictionaryContentPaths?: Set<string>;
            hasAudio?: boolean;
            hasDictionary?: boolean;
            hasFigure?: boolean;
            hasIndex?: boolean;
            hasLOA?: boolean;
            hasLOI?: boolean;
            hasLOT?: boolean;
            hasLOV?: boolean;
            hasMicrodata?: boolean;
            hasPageBreak?: boolean;
            hasPageList?: boolean;
            hasRDFa?: boolean;
            hasTable?: boolean;
            hasVideo?: boolean;
            sectionCount?: number;
            tocLinkCount?: number;
        };
        data: Uint8Array;
        files: Map<string, Uint8Array<ArrayBufferLike>>;
        hasContainer: boolean;
        mediaActiveClass?: string;
        mediaPlaybackActiveClass?: string;
        messages: ValidationMessage[];
        ncxUid?: string;
        obfuscatedResources?: Set<string>;
        opfPath?: string;
        options: ResolvedEpubCheckOptions;
        overlayTextLinks?: {
            fragment?: string;
            location: EPUBLocation;
            targetResource: string;
        }[];
        packageDocument?: PackageDocument;
        referencedUndeclaredResources?: Set<string>;
        rootfiles: Rootfile[];
        tocLinks?: {
            fragment?: string;
            location: EPUBLocation;
            targetResource: string;
        }[];
        version: "2.0"
        | "3.0"
        | "3.1"
        | "3.2"
        | "3.3";
        xmlParseFailures?: Map<string, XmlParseFailure>;
    }
    Index

    Properties

    contentFeatures? data files hasContainer mediaActiveClass? mediaPlaybackActiveClass? messages ncxUid? obfuscatedResources? opfPath? options overlayTextLinks? packageDocument? referencedUndeclaredResources? rootfiles tocLinks? version xmlParseFailures?

    Properties

    contentFeatures?: {
        dictionaryContentPaths?: Set<string>;
        hasAudio?: boolean;
        hasDictionary?: boolean;
        hasFigure?: boolean;
        hasIndex?: boolean;
        hasLOA?: boolean;
        hasLOI?: boolean;
        hasLOT?: boolean;
        hasLOV?: boolean;
        hasMicrodata?: boolean;
        hasPageBreak?: boolean;
        hasPageList?: boolean;
        hasRDFa?: boolean;
        hasTable?: boolean;
        hasVideo?: boolean;
        sectionCount?: number;
        tocLinkCount?: number;
    }

    Feature flags collected during content validation for cross-document checks

    data: Uint8Array

    EPUB file data

    files: Map<string, Uint8Array<ArrayBufferLike>>

    Files extracted from EPUB container

    hasContainer: boolean

    Whether an OCF container backs this validation.

    Java splits the package document checks in two (OPFChecker.check): with a container it runs checkPackage(), which owns the unique-identifier check, the guide, and the whole reference-resolution pass; without one it runs only checkContent(), the schema and handler checks. Single-file modes have no container, so anything resolving a path against one is meaningless there and Java stays silent rather than reporting an unresolvable target.

    mediaActiveClass?: string

    OPF media:active-class value (if declared)

    mediaPlaybackActiveClass?: string

    OPF media:playback-active-class value (if declared)

    messages: ValidationMessage[]

    Validation messages collected so far

    ncxUid?: string

    NCX UID for validation against OPF identifier

    obfuscatedResources?: Set<string>

    Resources marked with IDPF font obfuscation in encryption.xml

    opfPath?: string

    Path to the package document (OPF)

    options: ResolvedEpubCheckOptions

    Validation options

    overlayTextLinks?: {
        fragment?: string;
        location: EPUBLocation;
        targetResource: string;
    }[]

    Media overlay text link targets in order, for reading order validation (MED-015)

    packageDocument?: PackageDocument

    Parsed package document

    referencedUndeclaredResources?: Set<string>

    Resources referenced in content but not declared in manifest

    rootfiles: Rootfile[]

    Rootfiles found in container.xml

    tocLinks?: { fragment?: string; location: EPUBLocation; targetResource: string }[]

    TOC navigation link targets in order, for reading order validation (NAV-011)

    version: "2.0" | "3.0" | "3.1" | "3.2" | "3.3"

    Detected EPUB version

    xmlParseFailures?: Map<string, XmlParseFailure>

    Paths whose XML is not well-formed, keyed by path. A fatal parse error is reported once, at the point the document is read; later passes skip these paths rather than reporting the same failure again in their own terms. The failure records how far the parse got, which decides whether a document model exists for those passes to work from.

    Settings

    Member Visibility

    On This Page

    Properties