Skip to content

Commit e83ec4e

Browse files
committed
fix(docs): correct default highWaterMark to 65536 bytes
1 parent 335ede9 commit e83ec4e

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1120,7 +1120,7 @@ A callback called with an error or an object with the modem line values (cts, ds
11201120
| autoOpen | <code>boolean</code> | <code>true</code> | Automatically opens the port on `nextTick`. |
11211121
| baudRate | <code>number</code> | <code>9600</code> | 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. |
11221122
| dataBits | <code>number</code> | <code>8</code> | Must be one of these: 8, 7, 6, or 5. |
1123-
| highWaterMark | <code>number</code> | <code>16384</code> | The size of the read and write buffers defaults to 16k. |
1123+
| highWaterMark | <code>number</code> | <code>65536</code> | The size of the read and write buffers defaults to 64k. |
11241124
| lock | <code>boolean</code> | <code>true</code> | Prevent other processes from opening the port. Windows does not currently support `false`. |
11251125
| stopBits | <code>number</code> | <code>1</code> | Must be one of these: 1 or 2. |
11261126
| parity | <code>string</code> | <code>&quot;none&quot;</code> | Must be one of these: 'none', 'even', 'mark', 'odd', 'space'. |

lib/serialport.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ function allocNewReadPool(poolSize) {
6666
* @property {boolean} [autoOpen=true] Automatically opens the port on `nextTick`.
6767
* @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.
6868
* @property {number} [dataBits=8] Must be one of these: 8, 7, 6, or 5.
69-
* @property {number} [highWaterMark=16384] The size of the read and write buffers defaults to 16k.
69+
* @property {number} [highWaterMark=65536] The size of the read and write buffers defaults to 64k.
7070
* @property {boolean} [lock=true] Prevent other processes from opening the port. Windows does not currently support `false`.
7171
* @property {number} [stopBits=1] Must be one of these: 1 or 2.
7272
* @property {string} [parity=none] Must be one of these: 'none', 'even', 'mark', 'odd', 'space'.

0 commit comments

Comments
 (0)