Class Book

An Epub representation with methods for the loading, parsing and manipulation of its contents.

Param: url

Param: options

Param: options.requestMethod

a request function to use instead of the default

Param: options.requestCredentials

send the xhr request withCredentials

Param: options.requestHeaders

send the xhr request headers

Param: options.encoding

optional to pass 'binary' or base64' for archived Epubs

Param: options.replacements

use base64, blobUrl, or none for replacing assets in archived Epubs

Param: options.canonical

optional function to determine canonical urls for a path

Param: options.openAs

optional string to determine the input type

Param: options.store

cache the contents in local storage, value should be the name of the reader

Returns

Example

new Book("/path/to/book.epub", {})

Example

new Book({ replacements: "blobUrl" })

Implements

IEventEmitter<BookEvents>

Index

Constructors

constructor

new Book(
url?: string | ArrayBuffer | Blob | BookOptions,
options?: BookOptions,
): Book
Parameters
- Optionalurl: string | ArrayBuffer | Blob | BookOptions
- Optionaloptions: BookOptions
Returns Book
- Defined in book.ts:111

Properties

archived

archived: boolean

container

container: Container | undefined

cover

cover: string

displayOptions

displayOptions: DisplayOptions | undefined

emit

emit: <K extends string>(type: K, ...args: BookEvents[K]) => void

isOpen

isOpen: boolean

isRendered

isRendered: boolean

loaded

loaded: BookLoadedState

loading

loading: BookLoadingState

locations

locations: Locations

navigation: Navigation

off

off: <K extends string>(type: K, fn?: (...args: BookEvents[K]) => void) => void

on

on: <K extends string>(type: K, fn: (...args: BookEvents[K]) => void) => void

opened

opened: Promise<Book>

opening

opening: defer<Book>

package

package: Packaging | undefined

packaging

packaging: Packaging

pageList

pageList: PageList

path

path: Path | undefined

ready

ready: Promise<
    [
        PackagingManifestObject,
        Spine,
        PackagingMetadataObject,
        string,
        Navigation,
        Resources,
        DisplayOptions,
    ],
>

rendition

rendition: Rendition | undefined

request

request: RequestFunction

resources

resources: Resources

settings

settings: BookOptions

spine

spine: Spine

storage

storage: Store | undefined

url

url: Url

Methods

canonical

canonical(path: string): string
Get a canonical link to a path
Parameters
- path: string
Returns string
the canonical path string
- Defined in book.ts:448

coverUrl

coverUrl(): Promise<string | null>
Get the cover url

Returns Promise<string | null>
coverUrl
- Defined in book.ts:732

destroy

destroy(): void
Destroy the Book and all associated objects

Returns void
- Defined in book.ts:795

getRange

getRange(cfiRange: string): Promise<Range>
Find a DOM Range for a given CFI Range
Parameters
- cfiRange: string
  a epub cfi range
Returns Promise<Range>
- Defined in book.ts:767

key

key(identifier?: string): string
Generates the Book Key using the identifier in the manifest or other string provided
Parameters
- Optionalidentifier: string
  to use instead of metadata identifier
Returns string
key
- Defined in book.ts:787

load

load(path: string, _type?: string): Promise<unknown>
Load a resource from the Book
Parameters
- path: string
  path to the resource to load
- Optional_type: string
Returns Promise<unknown>
returns a promise with the requested resource
- Defined in book.ts:406

open

open(input: string | ArrayBuffer | Blob, what?: string): Promise<void>
Open a epub or url
Parameters
- input: string | ArrayBuffer | Blob
  Url, Path or ArrayBuffer
- Optionalwhat: string
  force opening as a certain type
Returns Promise<void>
of when the book has been loaded
Example
```
book.open("/path/to/book.epub")
```
- Defined in book.ts:307

renderTo

renderTo(element: string | HTMLElement, options?: RenditionOptions): Rendition
Sugar to render a book to an element
Parameters
- element: string | HTMLElement
  element or string to add a rendition to
- Optionaloptions: RenditionOptions
Returns Rendition
- Defined in book.ts:636

resolve

resolve(path: string, absolute?: boolean): string
Resolve a path to it's absolute position in the Book
Parameters
- path: string
- Optionalabsolute: boolean
  force resolving the full URL
Returns string
the resolved path string
- Defined in book.ts:421

section

section(target: string | number): Section | null
Gets a Section of the Book from the Spine Alias for book.spine.get
Parameters
- target: string | number
Returns Section | null
- Defined in book.ts:626

setRequestCredentials

setRequestCredentials(credentials: boolean): void
Set if request should use withCredentials
Parameters
- credentials: boolean
Returns void
- Defined in book.ts:647

setRequestHeaders

setRequestHeaders(headers: Record<string, string>): void
Set headers request should use
Parameters
- headers: Record<string, string>
Returns void
- Defined in book.ts:655

Class Book

Param: url

Param: options

Param: options.requestMethod

Param: options.requestCredentials

Param: options.requestHeaders

Param: options.encoding

Param: options.replacements

Param: options.canonical

Param: options.openAs

Param: options.store

Returns

Example

Example

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Book

Properties

archive

archived

container

cover

displayOptions

emit

isOpen

isRendered

loaded

loading

locations

navigation

off

on

opened

opening

package

packaging

pageList

path

ready

rendition

request

resources

settings

spine

storage

url

Methods

canonical

Parameters

Returns string

coverUrl

Returns Promise<string | null>

destroy

Returns void

getRange

Parameters

Returns Promise<Range>

key

Parameters

Returns string

load

Parameters

Returns Promise<unknown>

open

Parameters

Returns Promise<void>

Example

renderTo

Parameters

Returns Rendition

resolve

Parameters

Returns string

section