Skip to content

Commit 9f5b690

Browse files
dannyb648BridgeAR
authored andcommitted
doc: corrected tlsSocket.getPeerCertificate response type
Within tls.md, the documentation for the response of tlsSocket.getPeerCertificate() included subjectaltname documented as an array of values. However these values are actually returned as a single string of concatenated values. The documentation has been updated to reflect this. PR-URL: #27757 Fixes: #27721 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]>
1 parent d1da117 commit 9f5b690

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

doc/api/tls.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -917,8 +917,8 @@ certificate.
917917
It is returned as a `:` separated hexadecimal string. Example:
918918
`'2A:7A:C2:DD:...'`.
919919
* `ext_key_usage` {Array} (Optional) The extended key usage, a set of OIDs.
920-
* `subjectaltname` {Array} (Optional) An array of names for the subject, an
921-
alternative to the `subject` names.
920+
* `subjectaltname` {string} (Optional) A string containing concatenated names
921+
for the subject, an alternative to the `subject` names.
922922
* `infoAccess` {Array} (Optional) An array describing the AuthorityInfoAccess,
923923
used with OCSP.
924924
* `issuerCertificate` {Object} (Optional) The issuer certificate object. For

0 commit comments

Comments
 (0)