flex-lib-pdf-print

Version

About

PdfPrint is a simple library that enables printing PDF files on Windows and Unix operating systems.

Documentation

TSDoc documentation is not yet available.

Technologies used

• Typescript
• unix-print
• PDFtoPrinter.exe

Getting started

Installation

Before installing PdfPrint, environment variable NPM_TOKEN_PRIV has to be set. On linux, this variable can be set in terminal using export NPM_TOKEN_PRIV = your_token_here. By using export, environment variable will be reset once the terminal closes, so the better way of doing it is by modifying /etc/environment file. Once set, create .npmrc file in your project root. Paste the following into newly created file:

//registry.npmjs.org/:_authToken=${NPM_TOKEN_PRIV}

Once the above steps are done, npm install can be ran.

Windows Executable

When printing on Windows, PdfPrint internally uses PDFtoPrinter executable. To save space on git, this application is not included in the repository. Before using this library, please install it from the link below and place into binaries/ folder. http://www.columbia.edu/~em36/pdftoprinter.html

Using PdfPrint

// es2015 import
import PdfPrint from '@leapbit/flex-lib-pdf-print';

// node import
const PdfPrint = require('@leapbit/flex-lib-pdf-print');

// instantiating PdfPrint object
const pdfPrint = new PdfPrint({
    os: 'windows',
    // os: 'unix',
    // default OS is Unix
});

// printing using PdfPrint
try
{
    pdfPrint.print({
        file: 'C:\users\marko\Photos\receipt.pdf',
        printer: 'EPSON TM-T(203dpi) Receipt6',
        options: [''], // options are currently not available on Windows
    });
}
catch (error)
{
    console.log(error);
}

Running PdfPrint locally

PdfPrint playgound is located in dev.ts file.

You can modify and run your local test code using npm run dev.

Running the tests

Tests are currently not available.

Building

To build PdfPrint for all environments, use npm run build.

To build for browsers, use npm run build:esm.

To build for node projects, use npm run build:cjs.

To create a bundle for plain javascript/HTML that is included in <script> tag, use npm run build:bundle. Note: Before bundling, run esm build.

Deployment

Deployment is done with the CI gitlab.

Built With

• Typescript

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

• Kristian Hanzić

License

This project is licensed under the Trade Secret License

Acknowledgements

• None