npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

epub-generator

v1.0.1

Published

Generate simple EPUB books with simple API in Node.js.

Downloads

11

Readme

epub-generator

Generate simple EPUB books with simple API in Node.js.

API

EpubGenerator = require('epub-generator')

EpubGenerator( options )

Create and return an generator. The generator is also a stream. You can pipe it to another stream (e.g. the stream returned by fs.createWriteStream). You need to listen to writableStream's events to get the generation status, such as drain, error, finish, etc.

Options (all optional):

  • uuid an identifier of the book, will generate one if not given
  • title the book's title, default to blank
  • language language of the book, will try to detect system's default language or set to "en" if not given
  • date the modification date, default to the current date
  • author author of the book
  • description some description
  • rights rights information
  • cover the cover image path, add the image using methods below

generator.add( path, data, meta )

Add data as a file in epub bundle. The data can be a string, buffer, or stream. path is the file's path in epub bundle.

Hint: you can use XHTML, CSS and common images in epub bundle.

Meta (all optional):

  • mimetype the mimetype to override the default mimetype
  • toc whether this file should be added to TOC (table of contents)
  • title the title, used in TOC

generator.end( callback )

Finish adding data. The callback is added to the finish event of the stream.

LICENSE

MIT