cap-label-printer-plugin
TypeScript icon, indicating that this package has built-in type declarations

2.0.3 • Public • Published

cap-label-printer-plugin

An capacitor plugin for integrating with any label printer

Install

npm install cap-label-printer-plugin
npx cap sync

API

printLabel(...)

printLabel(opts: PrintingOptions) => Promise<void>

Print a label using EPL commands to a specific printer.

Param Type Description
opts PrintingOptions - The printing options, including printer name, address, and EPL commands.

discover()

discover() => Promise<PrinterDevices>

Discover available label printer devices.

Returns: Promise<PrinterDevices>


Interfaces

PrintingOptions

Represents the options for printing labels using the EPL (Eltron Programming Language) commands or a base64 encoded string image.

Prop Type Description
name string The name of the printer to use.
address string The network address, device ID, or connection URL of the printer.
eplCommands string The EPL commands to send to the printer for printing.
image string The base64 encoded image to print on the label.
width number The width of the label in pixels. default is 562px
height number The height of the label in pixels. default is auto.

PrinterDevices

Represents a collection of printer devices.

Prop Type Description
devices PrinterDevice[] An array of printer devices.

PrinterDevice

Represents a printer device with its name, address, and port information.

Prop Type Description
name string The name or model of the printer device.
address string The network address, device ID, or connection URL of the printer.
port 'USB' | 'NET' | 'BT' | 'Browser' The port protocol used to communicate with the printer. Should be one of "USB", "NET", "BT" (for Bluetooth), or "Browser"

Readme

Keywords

Package Sidebar

Install

npm i cap-label-printer-plugin

Weekly Downloads

95

Version

2.0.3

License

MIT

Unpacked Size

6.57 MB

Total Files

36

Last publish

Collaborators

  • uniquedj95