Interface RenderOptions

all options for epub rendering

interface RenderOptions {
    author?: string;
    copyright?: string;
    css?: string;
    description?: string;
    frames?: Map<string, string>;
    images?: Map<string, ImageData>;
    lang?: LangCode;
    missingImage?: MissingImage;
    publisher?: string;
    sections: readonly Section[];
    subjects?: readonly string[];
    title: string;
    uid?: string;
}

Properties

author? copyright? css? description? frames? images? lang? missingImage? publisher? sections subjects? title uid?

Properties

Optional author

author?: string

the author

Optional copyright

copyright?: string

a copyright statement for the epub

Optional css

css?: string

custom global css to apply

Optional description

description?: string

an extra description

Optional frames

frames?: Map<string, string>

iframes to include in the epub

If an iframe tag appears in sections, its src attribute must be present in this map. The value must be an xhtml frame document, unlike sections, this will not be converted to valid xhtml.

Optional images

images?: Map<string, ImageData>

images to include in the epub

If an img tag appears in sections, its src attribute must be present in this map.

Optional lang

lang?: LangCode

the two letter language code (default: "en")

Optional missingImage

missingImage?: MissingImage

how to handle missing images and iframes

Optional publisher

publisher?: string

the publisher

sections

sections: readonly Section[]

the content of the epub

Optional subjects

subjects?: readonly string[]

a set of subject tags

title

title: string

the title

Optional uid

uid?: string

a unique id for the epub

If omitted, one will be generated with uuid v4.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc