Skip to main content
Version: 9.x.x

Readline Parser

new Readline(options?)

A transform stream that emits data after a newline delimiter is received. To use the Readline parser, provide a delimiter (defaults to \n). Data is emitted as string controllable by the encoding option (defaults to utf8).

Arguments

  • options.delimiter?: string delimiter to use
  • options.encoding?: string text encoding for the stream

Example

const SerialPort = require('serialport')
const Readline = require('@serialport/parser-readline')
const port = new SerialPort('/dev/tty-usbserial1')

const parser = port.pipe(new Readline({ delimiter: '\r\n' }))
parser.on('data', console.log)