Skip to content

README.md

Latest commit

 

History

History
100 lines (65 loc) · 2.24 KB

README.md

File metadata and controls

100 lines (65 loc) · 2.24 KB
Raw

Node.js PDF printing

Build Status codecov

A utility to print PDF files from Node.js and Electron.

  • ✅ Works on Windows and Unix-like operating systems.
  • ✅ Supports label printers such as Rollo and Zebra.

Getting Started

Install using yarn:

yarn add pdf-to-printer

Or npm:

npm install --save pdf-to-printer

Basic Usage

Print a PDF file to the default printer:

import printer from "pdf-to-printer";

printer
  .print("assets/pdf-sample.pdf")
  .then(console.log)
  .catch(console.error);

API

.print(pdf[, options]) => Promise<void>

Arguments

  1. pdf (string): PDF file to print. Will throw an error if no PDF specified.
  2. options (Object [optional]):
    • options.printer: (string [optional]): Print to the specified printer. Will print to the default printer if name not specified. If the printer name mistyped or specified printer does not exist, nothing will print.

Returns

Promise<void>.

Examples

To print a PDF file to the default printer:

printer
  .print("assets/pdf-sample.pdf")
  .then(console.log)
  .catch(console.error);

To print to a specific printer, add the name of the printer to options:

const options = {
  printer: "Zebra"
};

printer
  .print("assets/pdf-sample.pdf", options)
  .then(console.log)
  .catch(console.error);

.list() => Promise<string[]>

Returns

Promise<string[]>: List of available printers.

Examples

printer
  .list()
  .then(console.log)
  .catch(console.error);

Examples

We have a few examples in the source code.

Contact

Please do not hesitate to report a bug or suggest an idea. You can do it here, or email me at artur.khusaenov at gmail dot com.

License

MIT