Skip to content

README.md

Latest commit

 

History

History
59 lines (39 loc) · 1.73 KB

README.md

File metadata and controls

59 lines (39 loc) · 1.73 KB

node-microinvoice

NPM Downloads

Fast & elegant PDF invoice generator for Node using PDFKit.

What Microinvoice does?

  • It builds invoices that look good
  • Generates a PDF in less than 30ms
  • Custom Styling & Text
  • Covers extended charsets like Russian, Polish (native PDF fonts only support Latin)
  • Transliterate to Latin when charset is not supported (Chinese, Arabic)
  • What do invoices look like?

Example

Why another invoice generator

This project was made for our own company Crisp. We generate thousands of HTML invoices every month. Given this scale, using Puppeteer for generating HTML to PDF would be very inefficient.

This library offers a elegant and minimal approach to generating invoices.

Who uses it?

Crisp

👋 You use microinvoice and you want to be listed there? Contact me.

How to install?

Include microinvoice in your package.json dependencies.

Alternatively, you can run npm install microinvoice --save.

How to use?

Import the module in your code:

import MicroInvoice from "microinvoice";

let myInvoice = new MicroInvoice({
  // Use example from examples/index.ts
});

// Render invoice as PDF
myInvoice.generate("example.pdf").then(() => {
  console.log("Invoice saved");
});