diff options
author | Antoine du Hamel <duhamelantoine1995@gmail.com> | 2022-04-22 01:31:09 +0300 |
---|---|---|
committer | Michaƫl Zasso <targos@protonmail.com> | 2022-04-28 07:57:21 +0300 |
commit | d9f3f05cabecfeff7c267b9193f21b71013679b0 (patch) | |
tree | 704edb957962f0864a52982e4a698bbac63ef274 /doc/api/tls.md | |
parent | 6fa080cb4874f4a459b862c81bca3132ad042e67 (diff) |
doc: fix outdated documentation for `family` property
Refs: https://github.com/nodejs/node/pull/41431
Fixes: https://github.com/nodejs/node/issues/42787
PR-URL: https://github.com/nodejs/node/pull/42789
Reviewed-By: Beth Griggs <bgriggs@redhat.com>
Reviewed-By: Mestery <mestery@protonmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Paolo Insogna <paolo@cowtech.it>
Diffstat (limited to 'doc/api/tls.md')
-rw-r--r-- | doc/api/tls.md | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/doc/api/tls.md b/doc/api/tls.md index 52e0e71f1e0..5c91de3fd93 100644 --- a/doc/api/tls.md +++ b/doc/api/tls.md @@ -955,13 +955,17 @@ tlsSocket.once('session', (session) => { <!-- YAML added: v0.11.4 +changes: + - version: v18.0.0 + pr-url: https://github.com/nodejs/node/pull/41431 + description: The `family` property now returns a number instead of a string. --> * Returns: {Object} Returns the bound `address`, the address `family` name, and `port` of the underlying socket as reported by the operating system: -`{ port: 12346, family: 'IPv4', address: '127.0.0.1' }`. +`{ port: 12346, family: 4, address: '127.0.0.1' }`. ### `tlsSocket.authorizationError` |