epubcheck-ts
    Preparing search index...

    Class EpubCheck

    Main EPUB validation class

    import { EpubCheck } from 'epubcheck-ts';

    // Validate from a Uint8Array (works in Node.js and browsers)
    const result = await EpubCheck.validate(epubData);

    if (result.valid) {
      console.log('EPUB is valid!');
    } else {
      console.log(`Found ${result.errorCount} errors`);
      for (const msg of result.messages) {
        console.log(`${msg.severity}: ${msg.message}`);
      }
    }
    Index

    Constructors

    constructor

    Accessors

    version

    Methods

    addMessage check checkExpanded checkSingleFile validate validateExpanded validateSingleFile

    Constructors

    Accessors

    • get version(): "2.0" | "3.0" | "3.1" | "3.2" | "3.3"

      Get the current EPUB version being validated against

      Returns "2.0" | "3.0" | "3.1" | "3.2" | "3.3"

    Methods

    • Validate an EPUB file

      Parameters

      • data: Uint8Array

        The EPUB file as a Uint8Array

      • Optionalfilename: string

        Optional filename, used for file-extension checks (PKG-016/017/024)

      Returns Promise<EpubCheckResult>

      Validation result

    • Validate an expanded EPUB directory (pre-read file map)

      Parameters

      • files: Map<string, Uint8Array<ArrayBufferLike>>

        Map of relative file paths to their content

      Returns Promise<EpubCheckResult>

      Validation result

    • Validate a single file (OPF, XHTML, etc.) without a full EPUB container

      Parameters

      • data: Uint8Array

        The file content

      • filename: string

        The filename (used for path in messages)

      Returns Promise<EpubCheckResult>

      Validation result

    • Static method to validate an EPUB file with default options

      Parameters

      • data: Uint8Array

        The EPUB file as a Uint8Array

      • options: EpubCheckOptions = {}

        Optional validation options

      • Optionalfilename: string

        Optional filename, used for file-extension checks

      Returns Promise<EpubCheckResult>

      Validation result

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods