1.0.3 • Published 8 years ago

epub-comic-gen v1.0.3

Weekly downloads
5
License
MIT
Repository
github
Last release
8 years ago

epub-comic-gen

Build Status npm version Inline docs Code Climate

Npm package to create comic epub books, without temporary files when using stream for reading and writing

Requirements

  • Node 4.0.0+

Installation

npm install --save epub-comic-gen

Usage

Complete

var Epub = require('epub-comic-gen');
var epub = new Epub(
    'node_modules/epub-comic-gen/exemples/Haruko.cbz',
    './',
    'Haruko.pub',
    'Haruko San No Kareshi',
    'Kuratsuka Riko',
    'ja-jp',
    'rtl'
);
epub.genrate("3.0", function(err, file){
    if(err) return throw err;
    console.log(file+'  file was created!');
})

Minimal

var epub2 = new Epub(
    'node_modules/epub-comic-gen/exemples/Haruko',
);
epub2.genrate(function(err, file){
    if(err) return throw err;
    console.log(file+'  file was created!');
})

Epub(comic, destinationFolder, destinationFile , title, author, language, direction )

Instantiates the object

Required

  • comic Path to images directory or cbz file

Optional

  • destinationFolder Path to output directory (default: The same of comic)
  • destinationFile Name of destination file (default: The same of comic + ".epub")
  • title Title of the Comic (default: the destinationFile without the ".epub")
  • author Author name (default: "Anonymous")
  • language Language of the comic (default: "en-us")
  • direction Base text direction, options "ltr" left-to-right or "rtl" right-to-left (default: "ltr")

genrate(version, endCallback(err, file))

Required

  • endCallback Callback executed on end or in case of error
    • err The error
    • file The patch of the file that was created

Optional

  • version The version of EPUB spec, currently only suport "3.0" (default: "3.0")

License

MIT