node-printer-roger
v1.0.6
Published
Create and manage one or multiple printers (w/ CUPS), send file path or node buffer with support for all lp options. Get feedback on jobs you sent.
Downloads
62
Maintainers
Readme
zuzel-printer
https://atmospherejs.com/zuzel/node-printer
It is based on node-printer
with bugfixes and support for node >= 0.10.x
npm install zuzel-printer
meteor add zuzel:node-printer
A tool to print document or data. Based on "lp" binary.
Supports complete set of lp options (http://unixhelp.ed.ac.uk/CGI/man-cgi?lp)
Based on armetiz/node-printer-lp and diegoalberto/node-printer-lp-complete and alepee/node-printer.
Supports Mac OS and Linux
Quick Examples
var Printer = require('node-printer');
var options = {
media: 'Custom.200x600mm',
n: 3
};
// Get available printers list
Printer.list();
// Create a new Pinter from available devices
var printer = new Printer('EPSON_SX510');
// Print from a buffer(could be text), file path
var fileBuffer = fs.readFileSync('/path/to/file.ext');
var jobFromBuffer = printer.printBuffer(fileBuffer, options); //or without options
var filePath = 'package.json';
var jobFromFile = printer.printFile(filePath, options);
// Cancel a job
jobFromFile.cancel();
// Listen events from job
job.once('sent', function () {
console.log('Job ' + job.identifier + ' has been sent');
});
job.on('completed', function () {
console.log('Job ' + job.identifier + ' has been printed');
job.removeAllListeners();
printer.destroy();
});
//destroys all child processes
printer.destroy()
Options map
Parameter options accepted by lp. If expects is blank '', no option value is required for the option.
'E': {
'options': ['E', 'encryption'],
'description': 'Forces encryption when connecting to the server',
'expects': '',
'default': false
},
'U': {
'options': ['U', 'Username', 'username'],
'description': 'Specifies the username to use when connecting to the server',
'expects': 'string'
},
'c': {
'options': ['c', 'backwardsCompatibility'],
'description': 'This option is provided for backwards-compatibility only. On systems that support it, this option forces the print file to be copied to the spool directory before printing. In CUPS, print files are always sent to the scheduler via IPP which has the same effect.',
'expects': '',
'default': false
},
'd': {
'options': ['d', 'destination'],
'description': 'Prints files to the named printer',
'expects': 'string'
},
'h': {
'options': ['h', 'hostname'],
'description': 'Chooses an alternate server',
'expects': 'string'
},
'i': {
'options': ['i', 'job-id'],
'description': 'Specifies an existing job to modify',
'expects': 'number'
},
'm': {
'options': ['m'],
'description': 'Sends an email when the job is completed',
'expects': ''
},
'n': {
'options': ['n', 'copies', 'numCopies'],
'description': 'Sets the number of copies to print from 1 to 100',
'expects': 'number',
'default': 1
},
'o': {
'options': ['o'],
'description': '"name=value [name=value ...]" Sets one or more job options',
'expects': 'string',
'default': ''
},
'q': {
'options': ['q', 'priority'],
'description': 'Sets the job priority from 1 (lowest) to 100 (highest). The default priority is 50',
'expects': 'number',
'default': 1
},
's': {
'options': ['s'],
'description': 'Do not report the resulting job IDs (silent mode.)',
'expects': ''
},
't': {
'options': ['t', 'name'],
'description': 'Sets the job name',
'expects': 'string'
},
'H': {
'options': ['H', 'when'],
'description': 'Specifies when the job should be printed. A value of immediate will print the file immediately, a value of hold will hold the job indefinitely, and a time value (HH:MM) will hold the job until the specified time. Use a value of resume with the -i option to resume a held job. Use a value of restart with the -i option to restart a completed job.',
'default': 'immediate',
'expects': 'string'
},
'P': {
'options': ['P', 'page-list'],
'description': 'page-list Specifies which pages to print in the document. The list can contain a list of numbers and ranges (#-#) separated by commas (e.g. 1,3-5,16).',
'expects': 'string'
}
For example
var options = {
q: 50,
P: "2-3"
};
Parameter options accepted by lp -o option if expects is blank '', no option value is required for the option This was written according to lp man page http://unixhelp.ed.ac.uk/CGI/man-cgi?lp */
'media': {
'options': ['media'],
'description': 'Sets the page size to size. Most printers support at least the size names "a4", "letter", and "legal".',
'expects': 'string',
'default': 'a4'
},
'landscape': {
'options': ['landscape'],
'description': 'landscape',
'expects': ''
},
'orientation-requested': {
'options': ['orientation-requested'],
'description': '',
'expects': 'number'
},
'sides': {
'options': ['sides'],
'description': 'Prints on one or two sides of the paper. The value "two-sided-long-edge" is normally used when printing portrait (unrotated) pages, while "two-sided-short-edge" is used for landscape pages.',
'expects': 'string'
},
'fitplot': {
'options': ['fitplot'],
'description': 'Scales the print file to fit on the page',
'expects': '',
'default': false
},
'scaling': {
'options': ['scaling'],
'description': 'Scales image files to use up to number percent of the page. Values greater than 100 cause the image file to be printed across multiple pages',
'expects': 'number'
},
'cpi': {
'options': ['cpi'],
'description': 'Sets the number of characters per inch to use when printing a text file. The default is 10',
'default': 10,
'expects': 'number'
},
'lpi': {
'options': ['lpi'],
'description': 'Sets the number of lines per inch to use when printing a text file. The default is 6',
'default': 6,
'expects': 'number'
},
'page-bottom': {
'options': ['page-bottom'],
'description': 'Sets the page margins when printing text files. The values are in points - there are 72 points to the inch',
'expects': 'number'
},
'page-left': {
'options': ['page-left'],
'description': 'Sets the page margins when printing text files. The values are in points - there are 72 points to the inch',
'expects': 'number'
},
'page-right': {
'options': ['page-right'],
'description': 'Sets the page margins when printing text files. The values are in points - there are 72 points to the inch',
'expects': 'number'
},
'page-top': {
'options': ['page-top'],
'description': 'Sets the page margins when printing text files. The values are in points - there are 72 points to the inch',
'expects': 'number'
}
For example
var options = {
'page-right': 140,
'lpi': 9
};
Optionally you can set this as a text value
var options = {
'o': 'page-right=140 lpi=9'
};
Roadmap
- [ ] Write more tests
- [ ] Find a way to emulate CUPS printers on Travis env