# node-microinvoice

[![NPM](https://img.shields.io/npm/v/microinvoice.svg)](https://www.npmjs.com/package/microinvoice) [![Downloads](https://img.shields.io/npm/dt/microinvoice.svg)](https://www.npmjs.com/package/microinvoice) 

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](/examples/example.png?raw=true "Invoice generated using Microinvoice")

## Why another invoice generator

This project was made for our own company [Crisp](https:/crisp.chat/). 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?

<table>
<tr>
<td align="center"><a href="https://crisp.chat/"><img src="https://crisp.chat/favicons/favicon-256x256.png" width="64" /></a></td>
</tr>
<tr>
<td align="center">Crisp</td>
</tr>
</table>

_👋 You use microinvoice and you want to be listed there? [Contact me](https://jamin.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:

```typescript
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");
});
```