Interface EpubStructure

The structure of an EPUB book.

interface EpubStructure {
    META_INF: {
        container.xml: string;
    } & EntryObject<unknown>;
    mimetype?: string;
    OEBPS: {
        content.opf: string;
        nav.xhtml: string;
        toc.ncx: string;
    } & EntryObject<unknown>;
}

Properties

META_INF mimetype? OEBPS

Properties

META_INF

META_INF: {
    container.xml: string;
} & EntryObject<unknown>

The META-INF directory of the EPUB book.

Type declaration

Optionalmimetype

mimetype?: string

The mimetype of the EPUB book.

OEBPS

OEBPS: {
    content.opf: string;
    nav.xhtml: string;
    toc.ncx: string;
} & EntryObject<unknown>

The OEBPS directory of the EPUB book.

Type declaration

  • content.opf: string

    The content.opf file. It contains the metadata and manifest of the EPUB book.

    See

    https://www.w3.org/TR/epub-33/#dfn-epub-content-document

  • nav.xhtml: string

    The nav.xhtml file. It contains the navigation of the EPUB book. This file is included for compatibility with EPUB 3.

  • toc.ncx: string

    The toc.ncx file. It contains the table of contents of the EPUB book. This file is included for compatibility with EPUB 2.

Settings

Member Visibility

On This Page

Properties