html library
HTML and HTMLZ parsing entry points.
Classes
- ArchiveEntry
- A physical entry of a book's container archive.
- BinaryFile
- Represents a binary book file.
- Book
- A fully parsed book, independent of its source format.
- BookCover
- A book cover: raw bytes plus the detected image type.
- BookFile
- Abstract representation of a file inside a book container.
- BookMetadata
- Format-agnostic book metadata extracted from any supported book file.
- BookStatistics
- Basic reading statistics computed from book content.
- DocumentBook
- A document-backed book produced by text and office-format adapters.
- Files
- The files contained in a parsed book.
- The navigation (table of contents) of a book.
- Represents a navigation point (table of contents entry) in a book.
- ReadingOrderItem
- One entry of a book's reading order.
- TextFile
- Represents a text book file.
Enums
- BookFormat
- The book formats supported by unseal.
Functions
-
parseHtmlBook(
List< int> bytes, {String fileName = 'index.html'}) → DocumentBook - Parses a standalone HTML, HTM or XHTML document.
-
parseHtmlzArchive(
Archive archive) → DocumentBook - Parses an already decoded HTMLZ archive.
-
parseHtmlzBook(
List< int> bytes) → DocumentBook - Parses an HTMLZ ZIP archive whose entry point is a top-level HTML file.
-
readHtmlMetadata(
List< int> bytes) → BookMetadata - Reads only standalone HTML metadata and headings are not retained.
-
readHtmlzMetadata(
List< int> bytes) → BookMetadata - Reads only the selected HTML and top-level OPF from an HTMLZ archive.
-
readHtmlzMetadataFromArchive(
Archive archive) → BookMetadata - Reads HTMLZ metadata from an already decoded archive without extracting CSS, images, fonts or unrelated resources.
Exceptions / Errors
- HtmlException
- Error thrown while reading a standalone HTML file or an HTMLZ archive.