npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@point-of-sale/network-receipt-printer

v2.0.0

Published

This is an library that allows you to print to a network receipt printer using Node network sockets.

Downloads

187

Readme

NetworkReceiptPrinter

This is an library that allows you to print to a network receipt printer using Node network sockets.

What does this library do?

In order to print a receipt on a receipt printer you need to build the receipt and encode it as in the ESC/POS or StarPRNT language. You can use the ReceiptPrinterEncoder library for this. You end up with an array of raw bytes that needs to be send to the printer. One way to do that is using a network connection.

Installation

If you want to use this libary, first install the package using npm:

npm install @point-of-sale/network-receipt-printer --save

In your project you can then import it, if you use ES6 modules:

import NetworkReceiptPrinter from '@point-of-sale/network-receipt-printer';

let receiptPrinter = new NetworkReceiptPrinter();

Or require it, if you are using CommonJS:

let NetworkReceiptPrinter = require('@point-of-sale/network-receipt-printer');

let receiptPrinter = new NetworkReceiptPrinter();

Configuration

When you create the NetworkReceiptPrinter object you can specify a number of options to help with the library with connecting to the device.

Network settings

When a network printer is connected to the network it will get assigned a IP address. Consult the manual of your printer for a method to get the network settings of your printer. Once you have the IP address of your printer, provide them as properties when you instantiate the NetworkReceiptPrinter object:

  • host: The IP address of the printer.
  • port: The port number of the printer, by default this is 9100.

For example, to connect to 192.168.1.133 using the default port:

const receiptPrinter = new NetworkReceiptPrinter({ 
    host:   '192.168.1.133'
});

Connect to a receipt printer

The actually connect to the printer you need to call the connect() function. To find out when a receipt printer is connected you can listen for the connected event using the addEventListener() function.

receiptPrinter.addEventListener('connected', device => {
    console.log(`Connected to printer`);
});

The callback of the connected event is passed an object with the following properties:

  • type Type of the connection that is used, in this case it is always network.

Commands

Once connected you can use the following command to print receipts.

Printing receipts

When you want to print a receipt, you can call the print() function with an array, or a typed array with bytes. The data must be properly encoded for the printer.

For example:

/* Encode the receipt */

let encoder = new ReceiptPrinterEncoder({
    language:  'esc-pos',
    codepageMapping: 'epson'
});

let data = encoder
    .initialize()
    .text('The quick brown fox jumps over the lazy dog')
    .newline()
    .qrcode('https://nielsleenheer.com')
    .encode();

/* Print the receipt */

receiptPrinter.print(data);

Disconnect from the printer

When you are done with printing, you can call the disconnect() function. This will terminate the connection to the printer. If the connection to the printer is closed, the library will emit a disconnected event.

receiptPrinter.addEventListener('disconnected', () => {
    console.log(`Disconnected from the printer`);
});

receiptPrinter.disconnect();

License

MIT