Class.PrinterClient

niimbotjs / PrinterClient

Class: PrinterClient

Constructors

new PrinterClient()

new PrinterClient(): PrinterClient

Returns

PrinterClient

Properties

Property	Modifier	Type	Default value
packetBuffer	private	Buffer	null
serial	private	SerialTransport	...

Methods

calibrateLabel()

calibrateLabel(label): Promise<Packet>

Parameters

Parameter	Type
label	LabelType

Returns

Promise<Packet>

Source

lib/printer.ts:321

---

close()

close(): void

Returns

void

Source

lib/printer.ts:54

---

endPagePrint()

endPagePrint(): Promise<Packet>

Returns

Promise<Packet>

Source

lib/printer.ts:302

---

endPrint()

endPrint(): Promise<Packet>

Returns

Promise<Packet>

Source

lib/printer.ts:296

---

getHeartBeat()

getHeartBeat(variant): Promise<object>

Parameters

Parameter	Type	Default value
variant	1 | 2 | 3 | 4	4

Returns

Promise<object>

Member	Type
doorOpen	boolean
hasPaper	boolean

Source

lib/printer.ts:213

---

getInfo()

getInfo(key): Promise<string | number>

Parameters

Parameter	Type
key	InfoCode

Returns

Promise<string | number>

Source

lib/printer.ts:191

---

getPrintStatus()

getPrintStatus(): Promise<object>

Returns

Promise<object>

Member	Type
page	number
progress1	number
progress2	number

Source

lib/printer.ts:178

---

getRFID()

getRFID(): Promise<object>

Returns

Promise<object>

Member	Type
barcode	string
serial	string
totalLength	number
type	number
usedLength	number
uuid	string

Source

lib/printer.ts:248

---

open()

open(path?): Promise<void>

Parameters

Parameter	Type
path?	string

Returns

Promise<void>

Source

lib/printer.ts:51

---

print()

print(sharpImage, __namedParameters): Promise<void>

Parameters

Parameter	Type
sharpImage	Sharp
__namedParameters	object
__namedParameters.density	number

Returns

Promise<void>

Source

lib/printer.ts:137

---

processChunk()

private processChunk(): Packet[]

Returns

Packet[]

Source

lib/printer.ts:108

---

receivePacket()

private receivePacket(responseCode): Promise<Packet>

Parameters

Parameter	Type
responseCode	number

Returns

Promise<Packet>

Source

lib/printer.ts:77

---

sendPacket()

private sendPacket(type, data, responseOffset): Promise<Packet>

Parameters

Parameter	Type	Default value
type	number	undefined
data	number[] | Buffer	undefined
responseOffset	number	1

Returns

Promise<Packet>

Source

lib/printer.ts:57

---

setBluetoothSound()

setBluetoothSound(enabled): Promise<Packet>

Parameters

Parameter	Type
enabled	boolean

Returns

Promise<Packet>

Source

lib/printer.ts:317

---

setDimensions()

setDimensions(width, height): Promise<Packet>

Parameters

Parameter	Type
width	number
height	number

Returns

Promise<Packet>

Source

lib/printer.ts:305

---

setLabelDensity()

setLabelDensity(density): Promise<Packet>

Parameters

Parameter	Type
density	number

Returns

Promise<Packet>

Source

lib/printer.ts:286

---

setLabelType()

setLabelType(type): Promise<Packet>

Parameters

Parameter	Type
type	number

Returns

Promise<Packet>

Source

lib/printer.ts:282

---

setPowerSound()

setPowerSound(enabled): Promise<Packet>

Parameters

Parameter	Type
enabled	boolean

Returns

Promise<Packet>

Source

lib/printer.ts:313

---

startPagePrint()

startPagePrint(): Promise<Packet>

Returns

Promise<Packet>

Source

lib/printer.ts:299

---

startPrint()

startPrint(): Promise<Packet>

Returns

Promise<Packet>

Source

lib/printer.ts:293