epubcheck-ts
    Preparing search index...

    Interface ValidationContext

    Internal validation context passed through the validation pipeline

    interface ValidationContext {
        data: Uint8Array;
        files: Map<string, Uint8Array<ArrayBufferLike>>;
        messages: ValidationMessage[];
        ncxUid?: string;
        obfuscatedResources?: Set<string>;
        opfPath?: string;
        options: Required<EpubCheckOptions>;
        packageDocument?: PackageDocument;
        referencedUndeclaredResources?: Set<string>;
        rootfiles: Rootfile[];
        tocLinks?: {
            fragment?: string;
            location: EPUBLocation;
            targetResource: string;
        }[];
        version: EPUBVersion;
    }
    Index

    Properties

    data files messages ncxUid? obfuscatedResources? opfPath? options packageDocument? referencedUndeclaredResources? rootfiles tocLinks? version

    Properties

    data: Uint8Array

    EPUB file data

    files: Map<string, Uint8Array<ArrayBufferLike>>

    Files extracted from EPUB container

    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: Required<EpubCheckOptions>

    Validation options

    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: EPUBVersion

    Detected EPUB version

    Settings

    Member Visibility

    On This Page

    Properties