From e83ec4e58523ec43ae544dee3f9e0a017b726c21 Mon Sep 17 00:00:00 2001 From: Francis Gulotta Date: Thu, 10 Aug 2017 16:30:33 -0400 Subject: [PATCH] fix(docs): correct default highWaterMark to 65536 bytes --- README.md | 2 +- lib/serialport.js | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 371ddf8a7..b9a6c977b 100644 --- a/README.md +++ b/README.md @@ -1120,7 +1120,7 @@ A callback called with an error or an object with the modem line values (cts, ds | autoOpen | boolean | true | Automatically opens the port on `nextTick`. | | baudRate | number | 9600 | The baud rate of the port to be opened. This should match one of the commonly available baud rates, such as 110, 300, 1200, 2400, 4800, 9600, 14400, 19200, 38400, 57600, or 115200. Custom rates are supported best effort per platform. The device connected to the serial port is not guaranteed to support the requested baud rate, even if the port itself supports that baud rate. | | dataBits | number | 8 | Must be one of these: 8, 7, 6, or 5. | -| highWaterMark | number | 16384 | The size of the read and write buffers defaults to 16k. | +| highWaterMark | number | 65536 | The size of the read and write buffers defaults to 64k. | | lock | boolean | true | Prevent other processes from opening the port. Windows does not currently support `false`. | | stopBits | number | 1 | Must be one of these: 1 or 2. | | parity | string | "none" | Must be one of these: 'none', 'even', 'mark', 'odd', 'space'. | diff --git a/lib/serialport.js b/lib/serialport.js index db40e2245..bfed7b66d 100644 --- a/lib/serialport.js +++ b/lib/serialport.js @@ -66,7 +66,7 @@ function allocNewReadPool(poolSize) { * @property {boolean} [autoOpen=true] Automatically opens the port on `nextTick`. * @property {number=} [baudRate=9600] The baud rate of the port to be opened. This should match one of the commonly available baud rates, such as 110, 300, 1200, 2400, 4800, 9600, 14400, 19200, 38400, 57600, or 115200. Custom rates are supported best effort per platform. The device connected to the serial port is not guaranteed to support the requested baud rate, even if the port itself supports that baud rate. * @property {number} [dataBits=8] Must be one of these: 8, 7, 6, or 5. - * @property {number} [highWaterMark=16384] The size of the read and write buffers defaults to 16k. + * @property {number} [highWaterMark=65536] The size of the read and write buffers defaults to 64k. * @property {boolean} [lock=true] Prevent other processes from opening the port. Windows does not currently support `false`. * @property {number} [stopBits=1] Must be one of these: 1 or 2. * @property {string} [parity=none] Must be one of these: 'none', 'even', 'mark', 'odd', 'space'.