hibas123
/
epub
Archived
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
This repository has been archived on 2019-08-30. You can view files and clone it, but cannot push or open issues or pull requests.
67 Commits 1 Branch 0 Tags 778 KiB
JavaScript 51.5%
TypeScript 48.5%
Go to file
Fabian Stamm 05667d10ba Fixing missing return value 2018-09-21 12:33:32 +02:00
example Using JSZip and make everything a promise 2018-09-17 22:29:03 +02:00
lib Fixing missing return value 2018-09-21 12:33:32 +02:00
src Fixing missing return value 2018-09-21 12:33:32 +02:00
.gitignore Add .gitignore 2013-12-03 15:17:28 +01:00
LICENSE added package.json 2011-06-13 23:20:44 +03:00
README.md Formatted README.md 2017-04-26 07:27:52 -05:00
alice.epub Using JSZip and make everything a promise 2018-09-17 22:29:03 +02:00
epub.d.ts Using JSZip and make everything a promise 2018-09-17 22:29:03 +02:00
package-lock.json Update dependencies 2018-06-03 21:03:39 +02:00
package.json Fixing missing return value 2018-09-21 12:33:32 +02:00
tsconfig.json Using JSZip and make everything a promise 2018-09-17 22:29:03 +02:00
yarn.lock Using JSZip and make everything a promise 2018-09-17 22:29:03 +02:00

README.md

epub

epub is a node.js module to parse EPUB electronic book files.

NB! Only ebooks in UTF-8 are currently supported!.

Installation

npm install epub

Or, if you want a pure-JS version (useful if used in a Node-Webkit app for example):

npm install epub --no-optional

Usage

var EPub = require("epub");
var epub = new EPub(epubfile, imagewebroot, chapterwebroot);

Where

  • epubfile is the file path to an EPUB file
  • imagewebroot is the prefix for image URL's. If it's /images/ then the actual URL (inside chapter HTML <img> blocks) is going to be /images/IMG_ID/IMG_FILENAME, IMG_ID can be used to fetch the image form the ebook with getImage. Default: /images/
  • chapterwebroot is the prefix for chapter URL's. If it's /chapter/ then the actual URL (inside chapter HTML <a> links) is going to be /chapters/CHAPTER_ID/CHAPTER_FILENAME, CHAPTER_ID can be used to fetch the image form the ebook with getChapter. Default: /links/

Before the contents of the ebook can be read, it must be opened (EPub is an EventEmitter).

epub.on("end", function(){
	// epub is now usable
	console.log(epub.metadata.title);

	epub.getChapter("chapter_id", function(err, text){});
});
epub.parse();

metadata

Property of the epub object that holds several metadata fields about the book.

epub = new EPub(...);
...
epub.metadata;

Available fields:

  • creator Author of the book (if multiple authors, then the first on the list) (Lewis Carroll)
  • creatorFileAs Author name on file (Carroll, Lewis)
  • title Title of the book (Alice's Adventures in Wonderland)
  • language Language code (en or en-us etc.)
  • subject Topic of the book (Fantasy)
  • date creation of the file (2006-08-12)
  • description

flow

flow is a property of the epub object and holds the actual list of chapters (TOC is just an indication and can link to a # url inside a chapter file)

epub = new EPub(...);
...
epub.flow.forEach(function(chapter){
	console.log(chapter.id);
});

Chapter id is needed to load the chapters getChapter

toc

toc is a property of the epub object and indicates a list of titles/urls for the TOC. Actual chapter and it's ID needs to be detected with the href property

getChapter(chapter_id, callback)

Load chapter text from the ebook.

var epub = new EPub(...);
...
epub.getChapter("chapter1", function(error, text){});

getChapterRaw(chapter_id, callback)

Load raw chapter text from the ebook.

getImage(image_id, callback)

Load image (as a Buffer value) from the ebook.

var epub = new EPub(...);
...
epub.getImage("image1", function(error, img, mimeType){});

getFile(file_id, callback)

Load any file (as a Buffer value) from the ebook.

var epub = new EPub(...);
...
epub.getFile("css1", function(error, data, mimeType){});