nginstack

Class: Spool

@nginstack/engine/lib/print/Spool~ Spool

new Spool(printerName)

Cria um objeto que permite criar trabalhos de impressão utilizando um spool de impressão previamente configurado no sistema operacional.

Os trabalhos de impressão criados por esta API são do tipo RAW, portanto, o conteúdo informado no método #write deve estar em um formato suportado pela impressora destino, sendo frequentemente utilizado o padrão de impressão ESC/POS.

É importante observar que nem todas as impressoras suportam impressões do tipo RAW ou no padrão ESC/POS, sendo necessário consultar a documentação do fabricante para verificar se a impressora utilizada é compatível. Esse padrão é comumente utilizado em impressoras voltadas para a impressão de cupons fiscais, recibos e etiquetas, não sendo comum em impressoras gerais de escritório, como impressoras jato de tinta ou laser. Essas últimas costumam utilizar linguagens de impressão próprias, como PCL ou PostScript, ou realizam apenas impressões gráficas por meio de drivers específicos do fabricante.

Parameters:
Name Type Description
printerName string

Nome da impressora para onde serão enviados os trabalhos.

Methods

<static> getPrinters()

Obtém a relação de impressoras disponíveis para impressão no sistema operacional.

Returns:

Nomes das impressoras disponíveis.

Type
Array.<string>

close( [waitPrint] [, timeout])

Finaliza o trabalho de impressão iniciado previamente pelo método #open.

Parameters:
Name Type Argument Default Description
waitPrint boolean <optional>
 false

Indica se aguarda a conclusão da impressão.
timeout number <optional>
 300000

Caso aguarde a impressão, indica o tempo máximo em milissegundos que deve aguardar a impressão concluir.

open(jobName)

Cria um novo trabalho de impressão que deve ser finalizado por meio do método #close.

Parameters:
Name Type Description
jobName string

Nome do trabalho de impressão.

write(data)

Escreve o dado informado no trabalho de impressão iniciado previamente pelo método #open.

Parameters:
Name Type Description
data string

Dados a serem impressos.

writeByte(data)

Escreve o byte informado no trabalho de impressão iniciado previamente pelo método #open.

Parameters:
Name Type Description
data number

Valor do byte a ser impresso.

writeln(data)

Escreve o dado informado acrescido de um salto de linha no padrão CRLF no trabalho de impressão iniciado previamente pelo método #open.

Parameters:
Name Type Description
data string

Dados a serem impressos.