docs(readyParser): correct the required parameters (#1392)

serialport · Nov 5, 2017 · dcd256d · dcd256d
1 parent f8f3ce5
commit dcd256d
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 2 deletions.
diff --git a/lib/parsers/ready.js b/lib/parsers/ready.js
@@ -10,12 +10,17 @@ To use the `Ready` parser provide a byte start sequence. After the bytes have be
 const SerialPort = require('serialport');
 const Ready = SerialPort.parsers.Ready;
 const port = new SerialPort('/dev/tty-usbserial1');
-const parser = port.pipe(new Ready({ data: 'READY' }));
+const parser = port.pipe(new Ready({ delimiter: 'READY' }));
 parser.on('ready', () => console.log('the ready byte sequence has been received'))
 parser.on('data', console.log); // all data after READY is received
 ```
  */
 class ReadyParser extends Transform {
+  /**
+   *
+   * @param {object} options
+   * @param {string|Buffer|array} options.delimiter
+   */
   constructor(options) {
     options = options || {};
     if (options.delimiter === undefined) {

diff --git a/test/manual-testing/read.js b/test/manual-testing/read.js
@@ -4,7 +4,7 @@ const SerialPort = require('../../');
 const ByteLength = SerialPort.parsers.ByteLength;
 const exec = require('child_process').exec;
 
-// Serial receiver device 
+// Serial receiver device
 const port = process.env.TEST_PORT_RX;
 // Expected number of bytes to receive (should make `size` in drain.js)
 const expected = 512;