Skip to content

tls, doc: documentation mentions unexisting clientError event #13417

New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Closed
ChALkeR opened this issue Jun 2, 2017 · 1 comment
Closed

tls, doc: documentation mentions unexisting clientError event #13417

ChALkeR opened this issue Jun 2, 2017 · 1 comment
Labels
doc Issues and PRs related to the documentations. tls Issues and PRs related to the tls subsystem.

Comments

@ChALkeR
Copy link
Member

ChALkeR commented Jun 2, 2017

  • Version: 8.0.0, 7.10.0, 6.10.3
  • Subsystem: tls, doc

Before 1ab6b21 (before 6.0.0) there was a clientError event in tls module. Since 6.0.0, it was renamed to tlsClientError, and atm there are no mentions of clientError in the code of the tls module.

But https://nodejs.org/api/tls.html#tls_tls_createserver_options_secureconnectionlistener states

A 'clientError' is emitted on the tls.Server object whenever a handshake times out.

I think that's a documentation error.

I didn't re-check, though, so this should be rechecked before fixing the docs.

/cc @indutny

@ChALkeR ChALkeR added doc Issues and PRs related to the documentations. tls Issues and PRs related to the tls subsystem. labels Jun 2, 2017
@silverwind
Copy link
Contributor

Fixed in 597ba15.

silverwind pushed a commit that referenced this issue Jun 8, 2017
After the renaming of `clientError` in TLS to `tlsClientError` in
1ab6b21,
the docs inconsistently referred the error as `clientError`, which is now
corrected.

Fixes: #13417
PR-URL: #13533
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: Roman Reiss <me@silverwind.io>
addaleax pushed a commit that referenced this issue Jun 10, 2017
After the renaming of `clientError` in TLS to `tlsClientError` in
1ab6b21,
the docs inconsistently referred the error as `clientError`, which is now
corrected.

Fixes: #13417
PR-URL: #13533
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: Roman Reiss <me@silverwind.io>
MylesBorins pushed a commit that referenced this issue Jul 17, 2017
After the renaming of `clientError` in TLS to `tlsClientError` in
1ab6b21,
the docs inconsistently referred the error as `clientError`, which is now
corrected.

Fixes: #13417
PR-URL: #13533
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: Roman Reiss <me@silverwind.io>
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
doc Issues and PRs related to the documentations. tls Issues and PRs related to the tls subsystem.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants