epubjs 学习笔记（一）

EPUB(function)

创建一本新书，用于初始化电子书的入口方法

// book = ePub(url,options )
const  book = ePub("/path/to/book.epub", {})

参数说明：

• url（string|ArrayBuffer）：书的地址，可以是网络资源url，也可以是本地的 也可以是一个字节码数组（ArrayBuffer）
• options（Object） 传递给书的对象

返回值：

• book（Object）一个新的电子书对象

Book (class）

一个Epub表示形式，带有用于加载，解析和操纵其内容的方法。

// book = new Book(url,options )
const  book = new Book("/path/to/book.epub", {})
const  book = new Book({ replacements: "blobUrl" })

参数说明：

• url（string）：可选参数，书的地址，可以是网络资源url，也可以是本地的
• options 可选参数（Object）

属性	类型	描述
requestMethod	method	一个要使用的请求函数，而不是默认函数
requestCredentials	Boolean	发送带有凭证的xhr请求
requestHeaders	Object	发送xhr请求标头
encoding	string	binary或base64 默认是binary
replacements	string	base64，blobUrl或none，默认是none
canonical	method	可选功能，用于确定路径的规范网址
openAs	string	确定输入类型的可选字符串

返回值：

• book（Object）： class Book 实例，一个新的电子书对象

静态成员：

• opened
• spine [Spine] 一份出版物资源的顺序清单，此资源通常是EPUB内容文件，用以表示该出版物的预设阅读顺序。
• locations [Locations]
• navigation [Navigation]
• pagelist [Pagelist]

实例成员：

• open(input, what) 打开epub或者url

参数	类型	描述
input	string/ArrayBuffer
what	string	什么 类型的方式打开，可选值binary ，base64，epub，opf，json，directory

返回值：Promise 当书加载完毕的时候返回

• load 从书中加载资源

参数	类型	描述
path	string	加载资源路径

返回值：Promise 当书加载完毕的时候返回

• resolve 找到它在书中的绝对位置的路径

参数	类型	描述
path	string	路径
absolute	boolern	可选参数 强制解析完整的URL

返回值：解析的路径字符串

• canonical 获取路径的标准链接

参数	类型	描述
path	string	路径

返回值 ： string 标准路径字符串

• section 获取Section 从书的 Spine Alias 用于book.spine.get

参数	类型	描述
target	string

返回值 ： `Section 对象

• renderTo(element, options?) 把book渲染到页面上

参数	类型	描述
element	element/string	element对象或者id字符串
options	object	可选参数

返回值：Rendition

• setRequestCredentials 设置请求是否应使用验证

参数	类型	描述
credentials	boolern

返回值：void

• setRequestHeaders

参数	类型	描述
headers	object	请求头

返回值：void

• coverUrl（）获取封面网址
  返回值：coverUrl 封面的url地址

• getRange（cfiRange）查找给定CFI范围的DOM范围

参数	类型	描述
cfiRange	epubCFI	epub cfi

返回值：Range

• key(identifier?) 使用目录或提供的其他字符串中的标识符生成书签

参数	类型	描述
identifier	string	标识符

返回值：key[string]

• destroy() 销毁书籍和所有相关对象