Documentation lack for parsers.ready

[MicroCheapFx]

• SerialPort Version: 6.0.0

• NodeJS Version: v8.2.1

• Operating System and Hardware Platform: Win 10 Ent

• Have you checked the right version of the api docs?: Yes.

• Are you having trouble installing and you checked the Installation Special Cases docs? Nope.

• Are you using Electron and have you checked the Electron Docs?: Nope.

Summary of Problem

Documentation issue.

While using Ready type parser, my debugger yelled at me

(node:10392) UnhandledPromiseRejectionWarning: Unhandled promise rejection (rejection id: 1): TypeError: "delimiter" is not a bufferable object

Steps and Code to Reproduce the Issue

Just follow the doc from npm and try to implement an ready parser. To fix this, I had to implement delimiter attribute in the Ready object.

In the doc, in the parsers.ready section you give

const parser = port.pipe(new Ready({ data: 'READY' }));

Should be

const parser = port.pipe(new Ready({ data: 'READY', delimiter:'\r\n' }));

Or whatever the delimiter you want as long as it is defined and not null.
As it is a promise based module, the error source is pretty hard to find.

I found the answer reading your code lib/parsers/ready.js:21

if (options.delimiter === undefined) {
  throw new TypeError('"delimiter" is not a bufferable object');
}

if (options.delimiter.length === 0) {
  throw new TypeError('"delimiter" has a 0 or undefined length');
}

Thank you to update the doc !

Have a good day !

[reconbot]

It doesn't look like data does anything at all! I'll fix the docs post haste.

It should be

const parser = port.pipe(new Ready({ delimiter: 'READY' }));

[MicroCheapFx]

Thank you !