Class Escpos`Abstract`

Abstract base class for ESC/POS thermal receipt printers.

Provides the complete ESC/POS formatting API — text, styles, barcodes, QR codes, and images. Hardware transport is handled by subclasses:

Network — TCP/IP printers via Node.js net.Socket.
Usb — USB printers via the usb npm package (libusb).
Dummy — In-memory buffer for testing without hardware.

Subclassing: Implement _raw(data: Buffer): void, open(): Promise<void>, and close(): Promise<void>. All other methods are provided by this class.

Example

const printer = new Network({ host: '192.168.1.100' });
await printer.open();

printer.setWithDefault({ bold: true, align: 'center' });
printer.textln('ACME Corp');
printer.setWithDefault(); // reset to defaults

printer.barcode('12345678', 'EAN8');
printer.cut();

await printer.close();

Since

1.0.0

Hierarchy (View Summary)

Escpos

Index

Constructors

constructor

Properties

magic profile

Constructors

constructor

new Escpos(profileName?: string): Escpos
Parameters
- OptionalprofileName: string
  Printer profile name from the capabilities database (e.g. "TM-T88V"). Defaults to "default". See ProfileManager.listProfiles for available names.
Returns Escpos
- Defined in Downloads/python-escpos-master/escpos-ts/src/Escpos.ts:196

Properties

`Protected` `Readonly`magic

magic: MagicEncode

`Protected` `Readonly`profile

profile: PrinterProfile

Methods

`Abstract`_raw

_raw(data: Buffer): void
Send a raw Buffer of bytes directly to the printer hardware.

All higher-level methods ultimately call this. Subclasses must implement it to write to the underlying transport (TCP socket, USB endpoint, etc.).
Parameters
- data: Buffer
  Buffer containing ESC/POS command bytes.
Returns void
- Defined in Downloads/python-escpos-master/escpos-ts/src/Escpos.ts:209

barcode

barcode(code: string, bc: string, opts?: BarcodeOptions): void
Print a hardware barcode.

Sends the appropriate GS k sequence for the requested barcode type and function type. Supports all types defined in BARCODE_TYPES (UPC-A, UPC-E, EAN8, EAN13, CODE39, ITF, NW7/CODABAR, CODE93, CODE128, and GS1 variants for Function Type B).
Parameters
- code: string
  Barcode data string.
- bc: string
  Barcode type name (e.g. 'CODE128', 'EAN13'). Names are normalised (non-alphanumeric removed, uppercased) before lookup.
- opts: BarcodeOptions = {}
  Optional barcode appearance settings; see BarcodeOptions.
Returns void
Throws
BarcodeTypeError if the type is unrecognised or unsupported.

Throws
BarcodeCodeError if code fails format validation and opts.check is true (default).

Throws
BarcodeSizeError if height or width are out of range.
Example
```
printer.barcode('012345678905', 'EAN13', { pos: 'BELOW', height: 80 });
printer.barcode('{B12345678', 'CODE128', { functionType: 'B' });
```
Since
1.0.0
- Defined in Downloads/python-escpos-master/escpos-ts/src/Escpos.ts:603

blockText

blockText(txt: string, font?: FontName, columns?: number): void
Print a word-wrapped text block.

Wraps txt at word boundaries to fit within the column width of the selected font, as reported by the active printer profile.
Parameters
- txt: string
  UTF-8 string to wrap and print.
- font: FontName = 'a'
  Font to use for column-width lookup ('a' or 'b'; default: 'a').
- Optionalcolumns: number
  Override column count (uses profile value if omitted).
Returns void
Since
1.0.0
- Defined in Downloads/python-escpos-master/escpos-ts/src/Escpos.ts:286

cashdraw

cashdraw(pin: number | number[]): void
Send a cash-drawer open pulse.
Parameters
- pin: number | number[]
  Cash-drawer pin: 2, 5, or a 5-element array [esc, p, m, t1, t2] for a custom DEC sequence.
Returns void
Throws
CashDrawerError if pin is not 2, 5, or a valid 5-element array.

Since
1.0.0
- Defined in Downloads/python-escpos-master/escpos-ts/src/Escpos.ts:542

`Abstract`close

close(): Promise<void>
Close the connection to the printer and release all resources.

Safe to call even if not connected. Subclass behaviour:
- Network.close — destroys the TCP socket.
- Usb.close — releases the USB interface and closes the device.
- Dummy.close — no-op.
Returns Promise<void>
Promise that resolves when all resources have been released.
- Defined in Downloads/python-escpos-master/escpos-ts/src/Escpos.ts:233

cut

cut(mode?: "FULL" | "PART", feed?: boolean): void
Cut the paper.

Feeds 6 lines before cutting unless feed is false. Falls back to a full cut when the profile does not support partial cuts, and vice versa.
Parameters
- mode: "FULL" | "PART" = 'FULL'
  'FULL' (default) for a complete cut, 'PART' to leave a small uncut section.
- feed: boolean = true
  Feed paper before cutting (default: true).
Returns void
Throws
Error if mode is not 'FULL' or 'PART'.

Since
1.0.0
- Defined in Downloads/python-escpos-master/escpos-ts/src/Escpos.ts:509

hw

hw(action: "INIT" | "SELECT" | "RESET"): void
Send a hardware control command to the printer.

Action Command Effect

'INIT' ESC @ Clear print buffer and reset modes to defaults

'SELECT' ESC = Select printer as the active peripheral

'RESET' ESC ? Soft reset
Parameters
- action: "INIT" | "SELECT" | "RESET"
  One of 'INIT', 'SELECT', or 'RESET'.
Returns void
Throws
Error if action is not one of the three valid values.

Since
1.0.0
- Defined in Downloads/python-escpos-master/escpos-ts/src/Escpos.ts:486

Action	Command	Effect
`'INIT'`	`ESC @`	Clear print buffer and reset modes to defaults
`'SELECT'`	`ESC =`	Select printer as the active peripheral
`'RESET'`	`ESC ?`	Soft reset

image

image(
source: string | Buffer<ArrayBufferLike>,
opts?: ImageOptions,
): Promise<void>
Print an image from a file path or raw image Buffer.

Supported formats: PNG, JPEG, BMP, GIF, TIFF.

The image is:
1. Loaded and decoded (alpha channel composited onto white background).
2. Converted to greyscale and thresholded at luminance 128.
3. Optionally centred within the profile's media width.
4. Split into vertical fragments if taller than fragmentHeight.
5. Encoded using the selected impl and written via _raw().
impl options:
- 'bitImageRaster' (default) — GS v 0; widest printer compatibility.
- 'graphics' — GS ( L; better alignment on some models.
- 'bitImageColumn' — ESC *; required for printers like IT80-002.
Parameters
- source: string | Buffer<ArrayBufferLike>
  Absolute file path or raw image Buffer.
- opts: ImageOptions = {}
  Image rendering options; see ImageOptions.
Returns Promise<void>
Throws
ImageWidthError if the image is wider than the profile's declared media width.
Example
```
await printer.image('./receipt-logo.png', { center: true });
await printer.image('./receipt-logo.png', { impl: 'bitImageColumn' });
```
Since
1.0.0
- Defined in Downloads/python-escpos-master/escpos-ts/src/Escpos.ts:741

linedisplay

linedisplay(text: string): void
Open the line display, clear it, write text, then close it.

Convenience wrapper around linedisplaySelect, linedisplayClear, and Escpos.text.
Parameters
- text: string
  Text to display on the customer-facing line display.
Returns void
Since
1.0.0
- Defined in Downloads/python-escpos-master/escpos-ts/src/Escpos.ts:863

linedisplayClear

linedisplayClear(): void
Clear the content of the line display (ESC @).

Returns void
Since
1.0.0
- Defined in Downloads/python-escpos-master/escpos-ts/src/Escpos.ts:850

linedisplaySelect

linedisplaySelect(select: boolean): void
Open or close the line (customer) display.
Parameters
- select: boolean
  true to select the display (ESC = 2), false to return to the printer (ESC = 1).
Returns void
Since
1.0.0
- Defined in Downloads/python-escpos-master/escpos-ts/src/Escpos.ts:841

lineSpacing

lineSpacing(spacing?: number, divisor?: 60 | 180 | 360): void
Set or reset the line spacing.

When called without arguments, resets line spacing to the printer default (ESC 2). When spacing is provided, sets the line spacing to spacing / divisor inches per dot using the matching ESC/POS command:

Divisor Command Range

60 ESC A 0–85

180 ESC 3 0–255

360 ESC + 0–255
Parameters
- Optionalspacing: number
  Spacing value in dots (omit to reset).
- divisor: 60 | 180 | 360 = 180
  Unit divisor: 60, 180, or 360 (default: 180).
Returns void
Throws
RangeError if divisor is not one of 60 | 180 | 360.

Throws
RangeError if spacing is outside the valid range for the divisor.

Since
1.0.0
- Defined in Downloads/python-escpos-master/escpos-ts/src/Escpos.ts:458

Divisor	Command	Range
60	`ESC A`	0–85
180	`ESC 3`	0–255
360	`ESC +`	0–255

ln

ln(count?: number): void
Print count blank lines.
Parameters
- count: number = 1
  Number of line feeds to emit (default: 1; must be ≥ 0).
Returns void
Throws
RangeError if count is negative.

Since
1.0.0
- Defined in Downloads/python-escpos-master/escpos-ts/src/Escpos.ts:270

`Abstract`open

open(): Promise<void>
Open the connection to the printer.

Must be called before any print commands are sent. Subclass behaviour:
- Network.open — establishes a TCP socket.
- Usb.open — opens and claims the USB device.
- Dummy.open — no-op (always resolves immediately).
Returns Promise<void>
Promise that resolves when the printer is ready to accept data.
- Defined in Downloads/python-escpos-master/escpos-ts/src/Escpos.ts:221

printAndFeed

printAndFeed(lines: number): void
Print and feed n lines (ESC d n).
Parameters
- lines: number
  Number of lines to feed (0–255).
Returns void
Since
1.0.0
- Defined in Downloads/python-escpos-master/escpos-ts/src/Escpos.ts:530

qr

qr(content: string, opts?: QrOptions): Promise<void>
Print a QR code.

Two rendering modes are available, controlled by opts.native:
- Software mode (native: false, default) — generates the QR matrix locally using the qrcode package and sends it as a raster image via image. Works on all printers that support raster images.
- Native mode (native: true) — sends the five GS ( k sub-commands (set model, size, error correction, store data, print) directly. Requires the printer to have a built-in QR engine (most Epson TM series).
Parameters
- content: string
  The string to encode (UTF-8).
- opts: QrOptions = {}
  QR code appearance options; see QrOptions.
Returns Promise<void>
Throws
Error if ec, size, or model values are outside valid ranges.
Example
```
await printer.qr('https://example.com', { size: 4, ec: QR_ECLEVEL_M });
```
Since
1.0.0
- Defined in Downloads/python-escpos-master/escpos-ts/src/Escpos.ts:669

set

set(opts: TextStyleOptions): void
Apply ESC/POS text style attributes.

Each field in opts that is defined emits the corresponding ESC/POS command immediately. Omitted fields are not changed on the printer.

For size changes, exactly one of customSize, doubleWidth, doubleHeight, or normalTextSize should be set.
Parameters
- opts: TextStyleOptions
  Style attributes to apply; see TextStyleOptions.
Returns void
Throws
SetVariableError if customSize is set but width or height is outside the 1–8 range.

Since
1.0.0
- Defined in Downloads/python-escpos-master/escpos-ts/src/Escpos.ts:348

setWithDefault

setWithDefault(opts?: TextStyleOptions): void
Apply text styles with full defaults merged in.

Merges opts over a complete default set (left align, Font A, no bold, no underline, 1×1 size, density 9) before calling set. Also auto-enables customSize when width or height > 1 is requested without an explicit size mode, so callers do not need to set the flag manually.

Calling with no arguments resets the printer to standard text defaults.
Parameters
- opts: TextStyleOptions = {}
  Partial style overrides (default: {} — full reset).
Returns void
Example
```
printer.setWithDefault({ bold: true, align: 'center', height: 2 });
printer.textln('TOTAL');
printer.setWithDefault(); // reset all styles
```
Since
1.0.0
- Defined in Downloads/python-escpos-master/escpos-ts/src/Escpos.ts:409

softwareColumns

softwareColumns(
    textList: string[],
    widths: number | number[],
    align: Alignment | Alignment[],
): void
Print a row of text in software-defined columns.

Lays out textList into adjacent fixed-width columns, word-wrapping each cell and aligning content per the corresponding align entry. Outputs one textln() call per row of the resulting grid.
Parameters
- textList: string[]
  Array of strings, one per column.
- widths: number | number[]
  Total line width (split evenly) or per-column width array.
- align: Alignment | Alignment[]
  Alignment for all columns or per-column alignment array.
Returns void
Example
```
// Receipt item line: name left-aligned, price right-aligned
printer.softwareColumns(['Americano', '$3.50'], [30, 10], ['left', 'right']);
```
Since
1.0.0
- Defined in Downloads/python-escpos-master/escpos-ts/src/Escpos.ts:310

text

text(txt: string): void
Print a string using automatic encoding selection.

Characters are encoded via MagicEncode, which automatically selects the best code page for each segment of the string and emits the necessary ESC t n code-page-switch commands.
Parameters
- txt: string
  UTF-8 string to print.
Returns void
Since
1.0.0
- Defined in Downloads/python-escpos-master/escpos-ts/src/Escpos.ts:247

textln

textln(txt?: string): void
Print a string followed by a line feed (\n).

Equivalent to printer.text(txt + '\n').
Parameters
- txt: string = ''
  UTF-8 string to print (default: '' — prints a blank line).
Returns void
Since
1.0.0
- Defined in Downloads/python-escpos-master/escpos-ts/src/Escpos.ts:259

`Static`checkBarcode

checkBarcode(bc: string, code: string): boolean
Validate a barcode code string against the format rules for a given barcode type.

Checks that the code length falls within an allowed range and that the string matches the required character set for the barcode type.
Parameters
- bc: string
  Barcode type name (e.g. 'CODE128', 'EAN13').
- code: string
  Barcode data string to validate.
Returns boolean
true if the code is valid for the given type.

Since
1.0.0
- Defined in Downloads/python-escpos-master/escpos-ts/src/Escpos.ts:567

Class EscposAbstract

Example

Since

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Escpos

Properties

Protected Readonlymagic

Protected Readonlyprofile

Methods

Abstract_raw

Parameters

Returns void

barcode

Parameters

Returns void

Throws

Throws

Throws

Example

Since

blockText

Parameters

Returns void

Since

cashdraw

Parameters

Returns void

Throws

Since

Abstractclose

Returns Promise<void>

cut

Parameters

Returns void

Throws

Since

hw

Parameters

Returns void

Throws

Since

image

Parameters

Returns Promise<void>

Throws

Example

Since

linedisplay

Parameters

Returns void

Since

linedisplayClear

Returns void

Since

linedisplaySelect

Parameters

Returns void

Since

lineSpacing

Parameters

Returns void

Throws

Throws

Since

ln

Parameters

Returns void

Throws

Since

Abstractopen

Returns Promise<void>

printAndFeed

Parameters

Class Escpos`Abstract`

`Protected` `Readonly`magic

`Protected` `Readonly`profile

`Abstract`_raw

`Abstract`close

`Abstract`open

`Static`checkBarcode