4ps-printer-js

A comprehensive printing library for receipt printers supporting multiple protocols and connection types including ESC/POS, Star, and SII protocols over network, serial, and USB connections.

Features

• Multiple Protocol Support: ESC/POS, ESC/POS SII, Star, PNG
• Flexible Connections: Network (TCP/IP), Serial Port, USB Device
• TypeScript Support: Full type definitions included
• Modern API: Promise-based with async/await support
• Markdown Printing: Convert markdown to receipt format

Installation

npm install 4ps-printer

Quick Start

import { Printer, PrinterConfig } from '4ps-printer';

const printer = new Printer();
const options = {
  destination: '192.168.1.100',
  printer: 'escpos',
  charactersPerLine: 48
};

const result = await printer.printMarkdown('# Receipt\n\nTotal: $10.00', options, page);

API Reference

Printer Class

The main class for handling print operations.

Methods

• printMarkdown(content: string, options: IPrintOptions, page?: any): Promise<any>

PrinterConfig

Configuration class for printer settings.

ConnectionManager

Manages different types of printer connections.

Supported Protocols

• ESC/POS: Standard receipt printer protocol
• ESC/POS SII: SII variant of ESC/POS
• Star: Star Micronics printer protocol
• PNG: Image-based printing

Supported Connections

• Network (TCP/IP): Connect via IP address and port
• Serial Port: Direct serial connection
• USB Device: USB-connected printers

License

ISC

Support

For issues and questions, please visit our GitHub repository.