Skip to content

Commit a596577

Browse files
Hannes-Magnusson-CKMylesBorins
authored andcommitted
doc: improve checkServerIdentity docs
PR-URL: #17203 Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Anna Henningsen <[email protected]>
1 parent 9b41c0b commit a596577

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

doc/api/tls.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -792,8 +792,9 @@ changes:
792792
* `servername`: {string} Server name for the SNI (Server Name Indication) TLS
793793
extension.
794794
* `checkServerIdentity(servername, cert)` {Function} A callback function
795-
to be used when checking the server's hostname against the certificate.
796-
This should throw an error if verification fails. The method should return
795+
   to be used (instead of the builtin `tls.checkServerIdentity()` function)
796+
when checking the server's hostname against the certificate.
797+
This should return an {Error} if verification fails. The method should return
797798
`undefined` if the `servername` and `cert` are verified.
798799
* `session` {Buffer} A `Buffer` instance, containing TLS session.
799800
* `minDHSize` {number} Minimum size of the DH parameter in bits to accept a

0 commit comments

Comments
 (0)