diff --git a/README.md b/README.md index d0bc11e4d..e5a767ceb 100644 --- a/README.md +++ b/README.md @@ -725,6 +725,8 @@ The default `Parsers` are [Transform streams](https://nodejs.org/api/stream.html | ByteLength | Class | is a transform stream that emits data as a buffer after a specific number of bytes are received. | | Delimiter | Class | is a transform stream that emits data each time a byte sequence is received. | | Readline | Class | is a transform stream that emits data after a newline delimiter is received. | +| Ready | Class | is a transform stream that waits for a sequence of "ready" bytes before emitting a ready event and emitting data events | +| Regex | Class | is a transform stream that uses a regular expression to split the incoming text upon. | **Example** ```js @@ -767,7 +769,7 @@ const parser = port.pipe(new Readline({ delimiter: '\r\n' })); parser.on('data', console.log); ``` -To use the `Ready` parser provide a byte start sequence. After the bytes have been received data events are passed through. +To use the `Ready` parser provide a byte start sequence. After the bytes have been received a ready event is fired and data events are passed through. ```js const SerialPort = require('serialport'); const Ready = SerialPort.parsers.Ready; diff --git a/lib/parsers/index.js b/lib/parsers/index.js index 1b8afa1ed..c05e05045 100644 --- a/lib/parsers/index.js +++ b/lib/parsers/index.js @@ -9,6 +9,9 @@ * @property {Class} [ByteLength] is a transform stream that emits data as a buffer after a specific number of bytes are received. * @property {Class} [Delimiter] is a transform stream that emits data each time a byte sequence is received. * @property {Class} [Readline] is a transform stream that emits data after a newline delimiter is received. + * @property {Class} [Ready] is a transform stream that waits for a sequence of "ready" bytes before emitting a ready event and emitting data events + * @property {Class} [Regex] is a transform stream that uses a regular expression to split the incoming text upon. + * @since 5.0.0 * @example ```js @@ -51,7 +54,7 @@ const parser = port.pipe(new Readline({ delimiter: '\r\n' })); parser.on('data', console.log); ``` -To use the `Ready` parser provide a byte start sequence. After the bytes have been received data events are passed through. +To use the `Ready` parser provide a byte start sequence. After the bytes have been received a ready event is fired and data events are passed through. ```js const SerialPort = require('serialport'); const Ready = SerialPort.parsers.Ready;