JSPM

  • Created
  • Published
  • Downloads 9127
  • Score
    100M100P100Q130067F
  • License MIT

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

Package Exports

  • pdf-to-printer

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (pdf-to-printer) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Node.js PDF printing

Codacy Badge 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.

Installation

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. Note: It must be a path to a PDF existing in the file system. You may take a look at this example if you need to download your PDF file first.
  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);

More 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