Skip to content

Commit 16f727d

Browse files
committed
[doc] Clarify PerMessageDeflate options
1 parent 0c8c0b8 commit 16f727d

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

doc/ws.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -66,12 +66,11 @@ status code, otherwise the returned value sets the value of the
6666
The extension is disabled when `false` (default value). If an object is
6767
provided then that is extension parameters:
6868

69-
- `serverNoContextTakeover` {Boolean} Whether to use context take over or not.
70-
- `clientNoContextTakeover` {Boolean} The value to be requested to clients
71-
whether to use context take over or not.
72-
- `serverMaxWindowBits` {Number} The value of windowBits.
73-
- `clientMaxWindowBits` {Number} The value of max windowBits to be requested
74-
to clients.
69+
- `serverNoContextTakeover` {Boolean} Whether to use context takeover or not.
70+
- `clientNoContextTakeover` {Boolean} Acknowledge disabling of client context
71+
takeover.
72+
- `serverMaxWindowBits` {Number} The value of `windowBits`.
73+
- `clientMaxWindowBits` {Number} Request a custom client window size.
7574
- `level` {Number} The value of zlib's `level` param (0-9, default 8).
7675
- `memLevel` {Number} The value of zlib's `memLevel` param (1-9, default 8).
7776
- `threshold` {Number} Payloads smaller than this will not be compressed.
@@ -198,8 +197,9 @@ This class represents a WebSocket. It extends the `EventEmitter`.
198197
- `ca` {Array} Trusted certificates.
199198

200199
`perMessageDeflate` default value is `true`. When using an object, parameters
201-
are the same of the server. The only difference is the direction of requests
202-
(e.g. `serverNoContextTakeover` is the value to be requested to the server).
200+
are the same of the server. The only difference is the direction of requests.
201+
For example, `serverNoContextTakeover` can be used to ask the server to
202+
disable context takeover.
203203

204204
Create a new WebSocket instance.
205205

0 commit comments

Comments
 (0)