BindUp

Book Schema

book

A global book configuration object.

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Access Restrictions	Defined In
Can be instantiated	No	Unknown status	No	Forbidden	Allowed	none	book.schema.json

Book Type

object (Book)

Book Properties

Property	Type	Required	Nullable	Defined by
manuscript	string	Required	cannot be null	Book
formats	array	Required	cannot be null	Book
title	string	Required	cannot be null	Book
author	Multiple	Required	cannot be null	Book
description	string	Optional	cannot be null	Book
publisher	string	Optional	cannot be null	Book
coverPath	string	Optional	cannot be null	Book
tocInTOC	boolean	Optional	cannot be null	Book
numberChaptersInTOC	boolean	Optional	cannot be null	Book
prependChapterTitles	boolean	Optional	cannot be null	Book
date	string	Optional	cannot be null	Book
lang	string	Optional	cannot be null	Book
css	string	Optional	cannot be null	Book
fonts	array	Optional	cannot be null	Book
epubVersion	number	Optional	cannot be null	Book
fetchTimeout	number	Optional	cannot be null	Book
retryTimes	number	Optional	cannot be null	Book
batchSize	number	Optional	cannot be null	Book
ignoreFailedDownloads	boolean	Optional	cannot be null	Book
verbose	boolean	Optional	cannot be null	Book

manuscript

The relative path to the manuscript folder.

manuscript

• is required

• Type: string

• cannot be null

• defined in: Book

manuscript Type

string

formats

An array of formats you want to print your book in (epub only as of now).

formats

• is required

• Type: string[]

• cannot be null

• defined in: Book

formats Type

string[]

title

The title of the book.

title

• is required

• Type: string

• cannot be null

• defined in: Book

title Type

string

author

The author of the book.

author

• is required

• Type: string[]

• cannot be null

• defined in: Book

author Type

string[]

description

The description of the book.

description

• is optional

• Type: string

• cannot be null

• defined in: Book

description Type

string

publisher

The publisher of the book.

publisher

• is optional

• Type: string

• cannot be null

• defined in: Book

publisher Type

string

coverPath

The path to the book cover (jpg, png).

coverPath

• is optional

• Type: string

• cannot be null

• defined in: Book

coverPath Type

string

tocInTOC

(Default true) Whether to show TOC entry in the reader’s Table of Contents; only for EPUB2.

tocInTOC

• is optional

• Type: boolean

• cannot be null

• defined in: Book

tocInTOC Type

boolean

numberChaptersInTOC

(Default false) Whether to number the items in the Table of Contents.

numberChaptersInTOC

• is optional

• Type: boolean

• cannot be null

• defined in: Book

numberChaptersInTOC Type

boolean

prependChapterTitles

(Default true) Whether to automatically number entries in TOC.

prependChapterTitles

• is optional

• Type: boolean

• cannot be null

• defined in: Book

prependChapterTitles Type

boolean

date

(Defaults to today) Publication date

date

• is optional

• Type: string

• cannot be null

• defined in: Book

date Type

string

lang

(Defaults to en) The book’s language as an ISO language code.

lang

• is optional

• Type: string

• cannot be null

• defined in: Book

lang Type

string

css

A CSS string that overrides default styles.

css

• is optional

• Type: string

• cannot be null

• defined in: Book

css Type

string

fonts

Array of fonts to include.

fonts

• is optional

• Type: object[] (Details)

• cannot be null

• defined in: Book

fonts Type

object[] (Details)

epubVersion

(Default 3) Either 3 or 2. The release version of EPUB to render your book to.

epubVersion

• is optional

• Type: number

• cannot be null

• defined in: Book

epubVersion Type

number

fetchTimeout

(Default 2000) Timeout time for requests, in milliseconds; Browsers need to support AbortController and signals for this to work.

fetchTimeout

• is optional

• Type: number

• cannot be null

• defined in: Book

fetchTimeout Type

number

retryTimes

(Default 3) How many times to retry fetching resources.

retryTimes

• is optional

• Type: number

• cannot be null

• defined in: Book

retryTimes Type

number

batchSize

(Default 100) The size of the batches to use when downloading files.

batchSize

• is optional

• Type: number

• cannot be null

• defined in: Book

batchSize Type

number

ignoreFailedDownloads

(Default false) Instead of throwing, emit a warning and write an empty file if a font or image fails to download.

ignoreFailedDownloads

• is optional

• Type: boolean

• cannot be null

• defined in: Book

ignoreFailedDownloads Type

boolean

verbose

(Default false) Whether to log progress messages; If a function is provided, the first argument will either be ‘log’ or ‘warn’.

verbose

• is optional

• Type: boolean

• cannot be null

• defined in: Book

verbose Type

boolean