https://github.com/vivify-ideas/node-printer-utilities
https://github.com/vivify-ideas/node-printer-utilities
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/vivify-ideas/node-printer-utilities
- Owner: Vivify-Ideas
- Created: 2022-03-23T12:06:58.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2023-11-09T12:19:01.000Z (over 1 year ago)
- Last Synced: 2025-02-14T22:04:18.241Z (3 months ago)
- Language: C++
- Size: 404 KB
- Stars: 1
- Watchers: 7
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Node Printer utility for Electron/NodeJS Applications
## Note
The package is still in Alpha testing. If you encounter any problems or dificulties running it, feel free to open an issue.
## Development of this package
To be able to recompile this package, you will have to install ```wkhtmltox``` native package that can be found on this [link.](https://wkhtmltopdf.org/downloads.html)
## Installation
```bash
npm install --save node-printer-utility
```
If your Electron and NodeJS NODE_MODULE version differs, you will have to rebuild this package with your Electron version using electron-rebuild after installing .
## Usage
This package offers printing of a HTML string through conversion to PDF using native ```wkhtmltox``` package, and then printing using native ```CUPS``` package.
If you wish to use printing capabilities of this package, you first have to call ```initSettings()``` method at the app startup, so the wkhtmltox initiates its configuration, and also be sure to to call ```deinitSettings()``` the application exit.
```js
const { getDefaultPrinter } = require('node-printer-utility');
console.log(getDefaultPrinter());
```
## Exported Methods
```js
initSettings()
```
```js
deinitSettings()
```
```js
getDefaultPrinter()
```
Html prop is a HTML string that will be converted to the PDF and then printer. Be sure to use PDF safe CSS.
PageHeight and PageWidth props are needed so that the PDF converter knows the dimensions of the page.
PaperSize property is used for the CUPS package to set the MEDIA property.
Success and Error props are callbacks used for additional JS work needed to be done after printing operation finishes.
Success callback returns JobID integer, and error callback returns string message with some information about the error.
```js
sendToPrinter(html, pageHeight, pageWidth, paper_size, success, error)
```