print-buddy

ESC/POS thermal printer library for Node.js with a composable, AST-based API.

Installation

pnpm add print-buddy

Quick Start

import { Printer, createConsoleProfile, Receipt, bold, underline } from 'print-buddy';

const printer = await Printer.create(createConsoleProfile());

const receipt = new Receipt()
  .line(bold('COFFEE SHOP'))
  .line('123 Main Street')
  .blank()
  .line(underline('Order #12345'))
  .blank()
  .table(['Item', 'Price'], [
    ['Latte', '$4.50'],
    ['Croissant', '$3.25'],
  ])
  .blank()
  .line(bold(underline('Total: $7.75')))
  .blank()
  .line('Thank you!')
  .cut();

await printer.print(receipt);
await printer.close();

USB Printer

import { Printer, getUsbProfile, Receipt, bold } from 'print-buddy';

// Use a preset printer model
const printer = await Printer.create(getUsbProfile('TMT20III'));

// Or configure manually
import { createUsbProfile } from 'print-buddy';

const printer = await Printer.create(createUsbProfile({
  vendorId: 0x04b8,
  productId: 0x0e28,
  width: 576,  // 80mm paper
}));

API

Receipt Builder

const receipt = new Receipt()
  .line(node)        // Print node followed by newline
  .blank(count?)     // Print blank lines (default: 1)
  .table(headers, rows)  // Two-column table
  .feed()            // Feed paper (no cut)
  .cut()             // Full paper cut
  .partialCut();     // Partial paper cut

Styling

Styles are composable - pass strings or wrap nodes to combine:

'Hello'                    // Plain text (string)
bold('Hello')              // Bold text
underline('Hello')         // Underlined text
bold(underline('Hello'))   // Bold + underlined

Printer Profiles

// Console output (for testing)
createConsoleProfile({ fontColumns?: number, width?: number })

// USB printer
createUsbProfile({
  vendorId: number,
  productId: number,
  endpoint?: number,
  timeout?: number,    // default: 2000ms
  fontColumns?: number, // default: 48
  width?: number,       // default: 576
})

// Preset profiles
getUsbProfile('TMT20III', '80mm')  // or '58mm'

Paper Widths

| Paper Size | Width (dots) | |------------|--------------| | 80mm | 576 | | 58mm | 384 |

License

MIT