Skip to content

Commit 50adf5c

Browse files
committed
fix protocol_version doc
1 parent 83455aa commit 50adf5c

1 file changed

Lines changed: 4 additions & 2 deletions

File tree

src/options.ts

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,8 +51,10 @@ type DeprecatedOptions = {
5151
* <li> <b>protocol</b>: <i>enum, accepted values: http, https, tcp, tcps</i> - The protocol used to communicate with the server. <br>
5252
* When <i>https</i> or <i>tcps</i> used, the connection is secured with TLS encryption.
5353
* </li>
54-
* <li> <b>protocol_version</b>: <i>enum, accepted values: auto, 1, 2</i> - The protocol version used to communicate with the server. <br>
55-
* When <i>https</i> or <i>tcps</i> used, the connection is secured with TLS encryption.
54+
* <li> <b>protocol_version</b>: <i>enum, accepted values: auto, 1, 2</i> - The protocol version used for data serialization. <br>
55+
* Version 1 uses text-based serialization for all data types. Version 2 uses binary encoding for doubles. <br>
56+
* When set to 'auto' (default for HTTP/HTTPS), the client automatically negotiates the highest supported version with the server. <br>
57+
* TCP/TCPS connections default to version 1.
5658
* </li>
5759
* <li> addr: <i>string</i> - Hostname and port, separated by colon. This key is mandatory, but the port part is optional. <br>
5860
* If no port is specified, a default will be used. <br>

0 commit comments

Comments
 (0)