epub-ocf

Simple node.js library to read entries inside an epub container.

Installation

$ npm install --save epub-ocf

API

Creating container object

var ocf = require('epub-ocf');
ocf('example.epub', function(err, container) { // ocf is an alias for ocf.zip
  container.readEntry("META-INF/container.xml", function(err, data) {    
    console.log(err, data);
  });
});

You can also create a container object from extracted epub directories.

ocf.dir('path/to/extracted/epub/directory/', function(err, container) {});

Or, epub directories served via http:

ocf.http('http://my.ebooks.service.org/ebook2/', function(err, container) {});

epub-ocf library can also guess which container method to use by examining the given uri.

// a Zip container
ocf.open('path/to/book.epub', function(err, container) {});

// a Directory container
ocf.open('path/to/book-dir', function(err, container) {});

// a Http container
ocf.open('http://my.ebooks.service.org/ebook2/', function(err, container) {});

Container methods

All container objects have readEntry, createReadStream and rootfiles methods.

container.readEntry(entryPath, cb)

Returns the contents of entry.

container.readEntry('META-INF/container.xml', function(err, content) {
  console.log(content);
});

container.createReadStream(entryPath)

Creates a readable stream for the entry.

var stream = container.createEntryStream('EPUB/images/cover.jpg');
stream.pipe(process.stdout);

container.rootfiles(cb)

Returns an array of rootfiles by parsing the META-INF/container.xml

container.rootfiles(function(err, files) {
  console.log(files); // [ 'EPUB/package.opf' ]
});

Running the tests

$ git clone https://github.com/glkz/epub-ocf.git
$ cd epub-ocf
$ npm install
$ npm test

License

See the LICENSE file.