Skip to content

Commit 4ea355d

Browse files
committed
[doc] Document 32-bit signed integer coercion for option values
Clarifiy that the values of the `maxBufferedChunks`, `maxFragments`, and `maxPayload` options are coerced to 32-bit signed integers.
1 parent 2120f4c commit 4ea355d

1 file changed

Lines changed: 18 additions & 12 deletions

File tree

doc/ws.md

Lines changed: 18 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -87,12 +87,15 @@ This class represents a WebSocket server. It extends the `EventEmitter`.
8787
- `handleProtocols` {Function} A function which can be used to handle the
8888
WebSocket subprotocols. See description below.
8989
- `host` {String} The hostname where to bind the server.
90-
- `maxBufferedChunks` {Number} The maximum number of buffered data chunks.
91-
Defaults to 1048576. Set to 0 to disable the limit.
92-
- `maxFragments` {Number} The maximum number of fragments in a message.
93-
Defaults to 131072. Set to 0 to disable the limit.
94-
- `maxPayload` {Number} The maximum allowed message size in bytes. Defaults to
95-
100 MiB (104857600 bytes).
90+
- `maxBufferedChunks` {Number} The maximum number of buffered data chunks. The
91+
value is coerced to a 32-bit signed integer. Defaults to 1048576. Set to 0
92+
to disable the limit.
93+
- `maxFragments` {Number} The maximum number of fragments in a message. The
94+
value is coerced to a 32-bit signed integer. Defaults to 131072. Set to 0 to
95+
disable the limit.
96+
- `maxPayload` {Number} The maximum allowed message size in bytes. The value
97+
is coerced to a 32-bit signed integer. Defaults to 104857600 (100 MiB). Set
98+
to 0 to disable the limit.
9699
- `noServer` {Boolean} Enable no server mode.
97100
- `path` {String} Accept only connections matching this path.
98101
- `perMessageDeflate` {Boolean|Object} Enable/disable permessage-deflate.
@@ -325,12 +328,15 @@ This class represents a WebSocket. It extends the `EventEmitter`.
325328
cryptographically strong random bytes.
326329
- `handshakeTimeout` {Number} Timeout in milliseconds for the handshake
327330
request. This is reset after every redirection.
328-
- `maxBufferedChunks` {Number} The maximum number of buffered data chunks.
329-
Defaults to 1048576. Set to 0 to disable the limit.
330-
- `maxFragments` {Number} The maximum number of fragments in a message.
331-
Defaults to 131072. Set to 0 to disable the limit.
332-
- `maxPayload` {Number} The maximum allowed message size in bytes. Defaults to
333-
100 MiB (104857600 bytes).
331+
- `maxBufferedChunks` {Number} The maximum number of buffered data chunks. The
332+
value is coerced to a 32-bit signed integer. Defaults to 1048576. Set to 0
333+
to disable the limit.
334+
- `maxFragments` {Number} The maximum number of fragments in a message. The
335+
value is coerced to a 32-bit signed integer. Defaults to 131072. Set to 0 to
336+
disable the limit.
337+
- `maxPayload` {Number} The maximum allowed message size in bytes. The value
338+
is coerced to a 32-bit signed integer. Defaults to 104857600 (100 MiB). Set
339+
to 0 to disable the limit.
334340
- `maxRedirects` {Number} The maximum number of redirects allowed. Defaults
335341
to 10.
336342
- `origin` {String} Value of the `Origin` or `Sec-WebSocket-Origin` header

0 commit comments

Comments
 (0)