thermal-printer-cordova-plugin

v1.0.6

Cordova wrapper for ESC/POS Thermal Printer library For more information about how to use this package see README

Latest version published 3 years ago

License: Apache-2.0

NPM

GitHub

Package Health Score

45 / 100

security
No known security issues
popularity
Limited
maintenance
Inactive
community
Limited

Explore Similar Packages

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
1.0.6	\|	08/2021	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

Apache-2.0

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Limited

Weekly Downloads (46)

GitHub Stars: 43
Forks: 31
Contributors: 6

Direct Usage Popularity

The npm package thermal-printer-cordova-plugin receives a total of 46 downloads a week. As such, we scored thermal-printer-cordova-plugin popularity level to be Limited.

Based on project statistics from the GitHub repository for the npm package thermal-printer-cordova-plugin, we found that it has been starred 43 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Limited

Readme.md: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 6
Funding: No

This project has seen only 10 or less contributors.

We found a way for you to contribute to the project! Looks like thermal-printer-cordova-plugin is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Inactive

Commit Frequency

No Recent Commits

Open Issues: 25
Open PR: 4
Last Release: 3 years ago
Last Commit: 1 year ago

Further analysis of the maintenance status of thermal-printer-cordova-plugin based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for thermal-printer-cordova-plugin is that it hasn't seen any new versions released to npm in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: not defined

Age: 3 years
Dependencies: 0 Direct
Versions: 8
Install Size: 52.1 kB
Dist-tags: 1
# of Files: 10
Maintainers: 1
TS Typings: No

thermal-printer-cordova-plugin has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

Cordova Plugin for Thermal Printer's

This plugin is a wrapper for the Android library for ESC/POS Thermal Printer.

Install

Cordova

$ cordova plugin add thermal-printer-cordova-plugin

Ionic

$ ionic cordova plugin add thermal-printer-cordova-plugin

Capacitor

$ npm install thermal-printer-cordova-plugin
$ npx cap sync

Don't forget to add BLUETOOTH and INTERNET (for TCP) permissions and for USB printers the android.hardware.usb.host feature to the AndroidManifest.xml.

listPrinters(data, successCallback, errorCallback)

List available printers

Param	Type	Description
data	`Object`	Data object
data.type	`"bluetooth"` \| `"usb"`	Type of list: bluetooth or usb
successCallback	`function`	Result on success
errorCallback	`function`	Result on failure

printFormattedText(data, successCallback, errorCallback)

Print a formatted text and feed paper

See: https://github.com/DantSu/ESCPOS-ThermalPrinter-Android#formatted-text--syntax-guide

Param	Type	Description
data	`Array.<Object>`	Data object
data.type	`"bluetooth"` \| `"tcp"` \| `"usb"`	List all bluetooth or usb printers
[data.id]	`string` \| `number`	ID of printer to find (Bluetooth: address, TCP: Use address + port instead, USB: deviceId)
[data.address]	`string`	If type is "tcp" then the IP Address of the printer
[data.port]	`number`	If type is "tcp" then the Port of the printer
[data.mmFeedPaper]	`number`	Millimeter distance feed paper at the end
[data.dotsFeedPaper]	`number`	Distance feed paper at the end
data.text	`string`	Formatted text to be printed
successCallback	`function`	Result on success
errorCallback	`function`	Result on failure

printFormattedTextAndCut(data, successCallback, errorCallback)

Print a formatted text, feed paper and cut the paper

See: https://github.com/DantSu/ESCPOS-ThermalPrinter-Android#formatted-text--syntax-guide

Param	Type	Description
data	`Array.<Object>`	Data object
data.type	`"bluetooth"` \| `"tcp"` \| `"usb"`	List all bluetooth or usb printers
[data.id]	`string` \| `number`	ID of printer to find (Bluetooth: address, TCP: Use address + port instead, USB: deviceId)
[data.address]	`string`	If type is "tcp" then the IP Address of the printer
[data.port]	`number`	If type is "tcp" then the Port of the printer
[data.mmFeedPaper]	`number`	Millimeter distance feed paper at the end
[data.dotsFeedPaper]	`number`	Distance feed paper at the end
data.text	`string`	Formatted text to be printed
successCallback	`function`	Result on success
errorCallback	`function`	Result on failure

getEncoding(data, successCallback, errorCallback)

Get the printer encoding when available

Param	Type	Description
data	`Array.<Object>`	Data object
data.type	`"bluetooth"` \| `"tcp"` \| `"usb"`	List all bluetooth or usb printers
[data.id]	`string` \| `number`	ID of printer to find (Bluetooth: address, TCP: Use address + port instead, USB: deviceId)
[data.address]	`string`	If type is "tcp" then the IP Address of the printer
[data.port]	`number`	If type is "tcp" then the Port of the printer
successCallback	`function`	Result on success
errorCallback	`function`	Result on failure

disconnectPrinter(data, successCallback, errorCallback)

Close the connection with the printer

Param	Type	Description
data	`Array.<Object>`	Data object
data.type	`"bluetooth"` \| `"tcp"` \| `"usb"`	List all bluetooth or usb printers
[data.id]	`string` \| `number`	ID of printer to find (Bluetooth: address, TCP: Use address + port instead, USB: deviceId)
[data.address]	`string`	If type is "tcp" then the IP Address of the printer
[data.port]	`number`	If type is "tcp" then the Port of the printer
successCallback	`function`	Result on success
errorCallback	`function`	Result on failure

requestPermissions(data, successCallback, errorCallback)

Request permissions for USB printers

Param	Type	Description
data	`Array.<Object>`	Data object
data.type	`"bluetooth"` \| `"tcp"` \| `"usb"`	List all bluetooth or usb printers
[data.id]	`string` \| `number`	ID of printer to find (Bluetooth: address, TCP: Use address + port instead, USB: deviceId)
[data.address]	`string`	If type is "tcp" then the IP Address of the printer
[data.port]	`number`	If type is "tcp" then the Port of the printer
successCallback	`function`	Result on success
errorCallback	`function`	Result on failure

bitmapToHexadecimalString(data, successCallback, errorCallback)

Convert Drawable instance to a hexadecimal string of the image data

Param	Type	Description
data	`Array.<Object>`	Data object
data.type	`"bluetooth"` \| `"tcp"` \| `"usb"`	List all bluetooth or usb printers
[data.id]	`string` \| `number`	ID of printer to find (Bluetooth: address, TCP: Use address + port instead, USB: deviceId)
[data.address]	`string`	If type is "tcp" then the IP Address of the printer
[data.port]	`number`	If type is "tcp" then the Port of the printer
data.base64	`string`	Base64 encoded picture string to convert
successCallback	`function`	Result on success
errorCallback	`function`	Result on failure

FAQs

What is thermal-printer-cordova-plugin?

Cordova wrapper for ESC/POS Thermal Printer library. Visit Snyk Advisor to see a full health score report for thermal-printer-cordova-plugin, including popularity, security, maintenance & community analysis.

Is thermal-printer-cordova-plugin popular?

The npm package thermal-printer-cordova-plugin receives a total of 46 weekly downloads. As such, thermal-printer-cordova-plugin popularity was classified as limited. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is thermal-printer-cordova-plugin well maintained?

We found indications that thermal-printer-cordova-plugin is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is thermal-printer-cordova-plugin safe to use?

The npm package thermal-printer-cordova-plugin was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 17 April-2024, at 19:16 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP