Skip to content

Commit ef8ada0

Browse files
authored
Merge pull request #683 from nats-io/update-readme
[DOC] added `handshakeFirst` tls option [ci skip]
2 parents 06d16f8 + f5ca307 commit ef8ada0

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

README.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -810,14 +810,15 @@ The following is the list of connection options and default values.
810810

811811
### TlsOptions
812812

813-
| Option | Default | Description |
814-
| ---------- | ------- | ---------------------------- |
815-
| `ca` | N/A | CA certificate |
816-
| `caFile` | | CA certificate filepath |
817-
| `cert` | N/A | Client certificate |
818-
| `certFile` | N/A | Client certificate file path |
819-
| `key` | N/A | Client key |
820-
| `keyFile` | N/A | Client key file path |
813+
| Option | Default | Description |
814+
| ---------------- | ------- |---------------------------------------------------------------------------------------------------------------------------------|
815+
| `ca` | N/A | CA certificate |
816+
| `caFile` | | CA certificate filepath |
817+
| `cert` | N/A | Client certificate |
818+
| `certFile` | N/A | Client certificate file path |
819+
| `key` | N/A | Client key |
820+
| `keyFile` | N/A | Client key file path |
821+
| `handshakeFirst` | false | Connects to the server directly as TLS rather than upgrade the connection. Note that the server must be configured accordingly. |
821822

822823
In some Node and Deno clients, having the option set to an empty option,
823824
requires the client have a secured connection.

0 commit comments

Comments
 (0)