From f5ca30709e1a4591902b7d2ff78e33b5ed60dfee Mon Sep 17 00:00:00 2001 From: Alberto Ricart Date: Mon, 8 Apr 2024 17:03:17 -0500 Subject: [PATCH] [DOC] added `handshakeFirst` tls option [ci skip] --- README.md | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 28b5b1c7..11e9b9b8 100644 --- a/README.md +++ b/README.md @@ -810,14 +810,15 @@ The following is the list of connection options and default values. ### TlsOptions -| Option | Default | Description | -| ---------- | ------- | ---------------------------- | -| `ca` | N/A | CA certificate | -| `caFile` | | CA certificate filepath | -| `cert` | N/A | Client certificate | -| `certFile` | N/A | Client certificate file path | -| `key` | N/A | Client key | -| `keyFile` | N/A | Client key file path | +| Option | Default | Description | +| ---------------- | ------- |---------------------------------------------------------------------------------------------------------------------------------| +| `ca` | N/A | CA certificate | +| `caFile` | | CA certificate filepath | +| `cert` | N/A | Client certificate | +| `certFile` | N/A | Client certificate file path | +| `key` | N/A | Client key | +| `keyFile` | N/A | Client key file path | +| `handshakeFirst` | false | Connects to the server directly as TLS rather than upgrade the connection. Note that the server must be configured accordingly. | In some Node and Deno clients, having the option set to an empty option, requires the client have a secured connection.