Skip to content

Commit d873996

Browse files
committed
more js doc
1 parent 4880075 commit d873996

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

src/options.ts

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -219,6 +219,13 @@ class SenderOptions {
219219
}
220220
}
221221

222+
/**
223+
* Resolves the protocol version, if it is set to 'auto'. <br>
224+
* If TCP transport is used, the protocol version will default to 1.
225+
* In case of HTTP transport the /settings endpoint of the database is used to find the protocol versions
226+
* supported by the server, and the highest will be selected.
227+
* @param options SenderOptions instance needs resolving protocol version
228+
*/
222229
static async resolveAuto(options: SenderOptions) {
223230
parseProtocolVersion(options);
224231
if (options.protocol_version !== PROTOCOL_VERSION_AUTO) {

0 commit comments

Comments
 (0)