A powerful yet easy-to-use epub parser
As it is written in TypeScript, types are already included in the package.
npm install @gxl/epub-parser --save
or if you prefer yarn
yarn add @gxl/epub-parser
parseEpub(target: string | buffer, options?: object): EpubObject
It can be the path to the file or file's binary string or buffer
type(optional): 'binaryString' | 'path' | 'buffer'
It forces the parser to treat supplied target as the defined type, if not defined the parser itself will decide how to treat the file (useful when you are not sure if the path is valid).
The output is an object which contains
info(private property names start with
_. I don't recommend using them, since they are subscribed to change).
structure is the parsed
toc of epub file, they contain information about how the book is constructed.
sections is an array of chapters or sections under chapters, they are referred in
structure. Each section object contains the raw html string and a few handy methods.
Section.prototype.toMarkdown: convert to markdown object.
Section.prototype.toHtmlObjects: convert to html object. And a note about
hrefin raw html stay untouched, but the
srcto base64 string, and alters
hrefso that they make sense in the parsed epub. And the parsed
hrefis something like
How to contribute
- Raise an issue in the issue section.
- PRs are the best.