Class Network

Network (TCP/IP) printer implementation.

Connects to an ESC/POS printer over a TCP socket using Node.js net.Socket.

Example

const printer = new Network({ host: '192.168.1.100', port: 9100 });
await printer.open();
printer.textln('Hello, World!');
printer.cut();
await printer.close();

Since

1.0.0

Hierarchy (View Summary)

Escpos
- Network

Index

Constructors

constructor

Properties

magic profile

Constructors

constructor

new Network(config: NetworkConfig): Network
Create a new Network printer instance.
Parameters
- config: NetworkConfig
  Network configuration options
  
  Configuration options for the Network printer.
  - host: string
    IP address or hostname of the printer
  - Optionalport?: number
    TCP port to connect to (default: 9100)
  - OptionalprofileName?: string
    Printer profile name to use (default: 'default')
  - Optionaltimeout?: number
    Connection timeout in milliseconds (default: 5000)
Returns Network
Since
1.0.0
Overrides Escpos.constructor
- Defined in Downloads/python-escpos-master/escpos-ts/src/printers/Network.ts:65

Properties

`Protected` `Readonly`magic

magic: MagicEncode

`Protected` `Readonly`profile

profile: PrinterProfile

Methods

_raw

_raw(data: Buffer): void
Write raw bytes directly to the TCP socket.

This is the low-level method called by all higher-level Escpos methods.
Parameters
- data: Buffer
  Buffer containing ESC/POS command bytes to send
Returns void
Throws
if socket is not open

Since
1.0.0
Overrides Escpos._raw
- Defined in Downloads/python-escpos-master/escpos-ts/src/printers/Network.ts:136

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
Inherited from Escpos.barcode
- 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
Inherited from Escpos.blockText
- 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
Inherited from Escpos.cashdraw
- Defined in Downloads/python-escpos-master/escpos-ts/src/Escpos.ts:542

close

close(): Promise<void>
Close the TCP connection.

Destroys the socket and cleans up the reference. Safe to call even if already closed (no-op).

Returns Promise<void>
Promise that resolves when the socket is destroyed

Since
1.0.0
Overrides Escpos.close
- Defined in Downloads/python-escpos-master/escpos-ts/src/printers/Network.ts:199

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
Inherited from Escpos.cut
- Defined in Downloads/python-escpos-master/escpos-ts/src/Escpos.ts:509

flush

flush(): Promise<void>
Wait for all buffered writes to be flushed to the OS TCP stack.

Call this after the last _raw() write in a print job to guarantee all data reaches the printer before close() destroys the socket.

Returns Promise<void>
Promise that resolves when the socket 'drain' event fires, or immediately if there is nothing to drain.

Since
1.0.0
- Defined in Downloads/python-escpos-master/escpos-ts/src/printers/Network.ts:182

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
Inherited from Escpos.hw
- 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
Inherited from Escpos.image
- 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
Inherited from Escpos.linedisplay
- 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
Inherited from Escpos.linedisplayClear
- 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
Inherited from Escpos.linedisplaySelect
- 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
Inherited from Escpos.lineSpacing
- 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
Inherited from Escpos.ln
- Defined in Downloads/python-escpos-master/escpos-ts/src/Escpos.ts:270

open

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

Resolves when the socket successfully connects. Rejects with DeviceNotFoundError if connection fails or times out.

Returns Promise<void>
Promise that resolves when connected

Throws
if connection fails or timeout expires

Since
1.0.0
Overrides Escpos.open
- Defined in Downloads/python-escpos-master/escpos-ts/src/printers/Network.ts:82

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
Inherited from Escpos.printAndFeed
- 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
Inherited from Escpos.qr
- Defined in Downloads/python-escpos-master/escpos-ts/src/Escpos.ts:669

read

read(length?: number): Promise<Buffer<ArrayBufferLike>>
Read data from the printer.

Resolves with up to length bytes received from the 'data' event. If length is not specified, returns the full first data chunk received.
Parameters
- Optionallength: number
  Maximum number of bytes to read (optional)
Returns Promise<Buffer<ArrayBufferLike>>
Promise resolving with a Buffer containing received data

Throws
if socket is not open

Since
1.0.0
- Defined in Downloads/python-escpos-master/escpos-ts/src/printers/Network.ts:160

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
Inherited from Escpos.set
- 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
Inherited from Escpos.setWithDefault
- 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
Inherited from Escpos.softwareColumns
- 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
Inherited from Escpos.text
- 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
Inherited from Escpos.textln
- 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
Inherited from Escpos.checkBarcode
- Defined in Downloads/python-escpos-master/escpos-ts/src/Escpos.ts:567

Class Network

Example

Since

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

host: string

Optionalport?: number

OptionalprofileName?: string

Optionaltimeout?: number

Returns Network

Since

Properties

Protected Readonlymagic

Protected Readonlyprofile

Methods

_raw

Parameters

Returns void

Throws

Since

barcode

Parameters

Returns void

Throws

Throws

Throws

Example

Since

blockText

Parameters

Returns void

Since

cashdraw

Parameters

Returns void

Throws

Since

close

Returns Promise<void>

Since

cut

Parameters

Returns void

Throws

Since

flush

Returns Promise<void>

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

`Optional`port?: number

`Optional`profileName?: string

`Optional`timeout?: number

`Protected` `Readonly`magic

`Protected` `Readonly`profile

`Static`checkBarcode