From e786fde2a5b3aaccb811a3e685482c82770f3b15 Mon Sep 17 00:00:00 2001 From: Hannes Magnusson Date: Tue, 21 Nov 2017 13:36:08 -0800 Subject: [PATCH] doc: improve checkServerIdentity docs PR-URL: https://github.com/nodejs/node/pull/17203 Reviewed-By: Luigi Pinca Reviewed-By: James M Snell Reviewed-By: Anna Henningsen --- doc/api/tls.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/doc/api/tls.md b/doc/api/tls.md index 3592efca78b175..cecccb8aec318a 100644 --- a/doc/api/tls.md +++ b/doc/api/tls.md @@ -792,8 +792,9 @@ changes: * `servername`: {string} Server name for the SNI (Server Name Indication) TLS extension. * `checkServerIdentity(servername, cert)` {Function} A callback function - to be used when checking the server's hostname against the certificate. - This should throw an error if verification fails. The method should return +    to be used (instead of the builtin `tls.checkServerIdentity()` function) + when checking the server's hostname against the certificate. + This should return an {Error} if verification fails. The method should return `undefined` if the `servername` and `cert` are verified. * `session` {Buffer} A `Buffer` instance, containing TLS session. * `minDHSize` {number} Minimum size of the DH parameter in bits to accept a