# Book An Epub representation with methods for the loading, parsing and manipulation of its contents. **Kind**: global class * [Book](#Book) * [new Book([input], [options])](#new_Book_new) * _instance_ * [.clear()](#Book+clear) * [.open(input, [openAs])](#Book+open) ⇒ [Promise.<Book>](#Book) * [.load(path, [type])](#Book+load) ⇒ Promise.<any> * [.resolve(path, [absolute])](#Book+resolve) ⇒ string * [.canonical(path)](#Book+canonical) ⇒ string * [.section([target])](#Book+section) ⇒ Section \| null * [.renderTo(element, [options])](#Book+renderTo) ⇒ Rendition * [.setRequestCredentials(credentials)](#Book+setRequestCredentials) * [.setRequestHeaders(headers)](#Book+setRequestHeaders) * [.coverUrl()](#Book+coverUrl) ⇒ Promise.<string> * [.getRange(cfiRange)](#Book+getRange) ⇒ Promise.<Range> * [.key([identifier])](#Book+key) ⇒ string * [.destroy()](#Book+destroy) * _static_ * [.request](#Book.request) : function * [.storage](#Book.storage) : Storage * [.rendition](#Book.rendition) : Rendition * [.container](#Book.container) : Container * [.packaging](#Book.packaging) : Packaging * [.resources](#Book.resources) : Resources * [.sections](#Book.sections) : Sections * [.locations](#Book.locations) : Locations * [.navigation](#Book.navigation) : Navigation * [.url](#Book.url) : Url * [.archived](#Book.archived) : boolean * [.cover](#Book.cover) : string * [.path](#Book.path) : Path * [.isOpen](#Book.isOpen) : boolean * [.opened](#Book.opened) : [Promise.<Book>](#Book) * [.loaded](#Book.loaded) : object * ["openFailed" (error)](#Book.event_openFailed) ## new Book([input], [options]) Constructor | Param | Type | Default | Description | | --- | --- | --- | --- | | [input] | string \| ArrayBuffer | | Url, Path or ArrayBuffer | | [options] | object | | | | [options.format] | string | "'xml'" | epub container format | | [options.request] | object | | object options to xhr request | | [options.request.method] | function | | a request function to use instead of the default | | [options.request.withCredentials] | boolean | false | send the xhr request withCredentials | | [options.request.headers] | Array.<string> | [] | send the xhr request headers | | [options.encoding] | string | "'binary'" | optional to pass `"binary"` or `"base64"` for archived Epubs | | [options.replacements] | string | null | use `"base64"` or `"blobUrl"` for replacing assets | | [options.canonical] | function | | optional function to determine canonical urls for a path | | [options.store] | string | null | cache the contents in local storage, value should be the name of the reader | **Example** ```js new Book() ``` **Example** ```js new Book("/path/to/book/", { store: "epub-js" }) ``` **Example** ```js new Book({ replacements: "base64", store: "epub-js" }) ``` ## book.clear() Clear parts **Kind**: instance method of [Book](#Book) ## book.open(input, [openAs]) ⇒ [Promise.<Book>](#Book) Open a epub or url **Kind**: instance method of [Book](#Book) **Returns**: [Promise.<Book>](#Book) - of when the book has been loaded | Param | Type | Description | | --- | --- | --- | | input | string \| ArrayBuffer | Url, Path or ArrayBuffer | | [openAs] | string | input type: `"binary"` OR `"base64"` OR `"epub"` OR `"json"` OR `"directory"` | **Example** ```js book.open("/path/to/book/") ``` **Example** ```js book.open("/path/to/book.epub") ``` **Example** ```js book.open("https://example.com/book/") ``` **Example** ```js book.open("https://example.com/book.epub") ``` **Example** ```js book.open([arraybuffer], "binary") ``` ## book.load(path, [type]) ⇒ Promise.<any> Load a resource from the Book **Kind**: instance method of [Book](#Book) **Returns**: Promise.<any> - returns a promise with the requested resource | Param | Type | Default | Description | | --- | --- | --- | --- | | path | string | | path to the resource to load | | [type] | string | null | | ## book.resolve(path, [absolute]) ⇒ string Resolve a path to it's absolute position in the Book **Kind**: instance method of [Book](#Book) **Returns**: string - the resolved path string | Param | Type | Default | Description | | --- | --- | --- | --- | | path | string | | | | [absolute] | boolean | false | force resolving the full URL | ## book.canonical(path) ⇒ string Get a canonical link to a path **Kind**: instance method of [Book](#Book) **Returns**: string - the canonical path string | Param | Type | | --- | --- | | path | string | ## book.section([target]) ⇒ Section \| null Gets a Section of the Book from the Spine Alias for `book.sections.get` **Kind**: instance method of [Book](#Book) | Param | Type | | --- | --- | | [target] | string \| number | **Example** ```js book.section() ``` **Example** ```js book.section(3) ``` **Example** ```js book.section("#chapter_001") ``` **Example** ```js book.section("chapter_001.xhtml") ``` **Example** ```js book.section("epubcfi(/6/8!/4/2/16/1:0)") ``` ## book.renderTo(element, [options]) ⇒ Rendition Sugar to render a book to an element **Kind**: instance method of [Book](#Book) | Param | Type | Description | | --- | --- | --- | | element | Element \| string | element or string to add a rendition to | | [options] | object | | ## book.setRequestCredentials(credentials) Set if request should use withCredentials **Kind**: instance method of [Book](#Book) | Param | Type | | --- | --- | | credentials | boolean | ## book.setRequestHeaders(headers) Set headers request should use **Kind**: instance method of [Book](#Book) | Param | Type | | --- | --- | | headers | Array.<string> | ## book.coverUrl() ⇒ Promise.<string> Get the cover url **Kind**: instance method of [Book](#Book) **Returns**: Promise.<string> - coverUrl ## book.getRange(cfiRange) ⇒ Promise.<Range> Find a DOM Range for a given CFI Range **Kind**: instance method of [Book](#Book) | Param | Type | Description | | --- | --- | --- | | cfiRange | EpubCFI | a epub cfi range | ## book.key([identifier]) ⇒ string Generates the Book Key using the identifier in the manifest or other string provided **Kind**: instance method of [Book](#Book) **Returns**: string - key | Param | Type | Description | | --- | --- | --- | | [identifier] | string | to use instead of metadata identifier | ## book.destroy() Destroy the Book and all associated objects **Kind**: instance method of [Book](#Book) ## Book.request : function **Kind**: static property of [Book](#Book) **Read only**: true ## Book.storage : Storage **Kind**: static property of [Book](#Book) **Read only**: true ## Book.rendition : Rendition **Kind**: static property of [Book](#Book) **Read only**: true ## Book.container : Container **Kind**: static property of [Book](#Book) **Read only**: true ## Book.packaging : Packaging **Kind**: static property of [Book](#Book) **Read only**: true ## Book.resources : Resources **Kind**: static property of [Book](#Book) **Read only**: true ## Book.sections : Sections **Kind**: static property of [Book](#Book) **Read only**: true ## Book.locations : Locations **Kind**: static property of [Book](#Book) **Read only**: true ## Book.navigation : Navigation **Kind**: static property of [Book](#Book) **Read only**: true ## Book.url : Url **Kind**: static property of [Book](#Book) **Read only**: true ## Book.archived : boolean **Kind**: static property of [Book](#Book) **Read only**: true ## Book.cover : string **Kind**: static property of [Book](#Book) **Read only**: true ## Book.path : Path **Kind**: static property of [Book](#Book) **Read only**: true ## Book.isOpen : boolean **Kind**: static property of [Book](#Book) **Read only**: true ## Book.opened : [Promise.<Book>](#Book) returns after the book is loaded **Kind**: static property of [Book](#Book) **Read only**: true ## Book.loaded : object Sequential loading of tasks **Kind**: static property of [Book](#Book) **Read only**: true **Properties** | Name | Type | | --- | --- | | packaging | Promise.<Packaging> | | resources | Promise.<Resources> | | navigation | Promise.<Navigation> | | sections | Promise.<Sections> | | cover | Promise.<string> | ## "openFailed" (error) **Kind**: event emitted by [Book](#Book) | Param | Type | | --- | --- | | error | object |