doc: add description for the listener argument

Clarify that `listener` is registered as a one-time listener of the `'connect'` event. PR-URL: #28500 Fixes: #28217 Reviewed-By: Roman Reiss <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]> Reviewed-By: Yongsheng Zhang <[email protected]>
nodejs · Jul 20, 2019 · 24a77ae · 24a77ae
1 parent 4c333f4
commit 24a77ae
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/doc/api/http2.md b/doc/api/http2.md
@@ -2206,7 +2206,8 @@ changes:
     instance passed to `connect` and the `options` object, and returns any
     [`Duplex`][] stream that is to be used as the connection for this session.
   * ...: Any [`net.connect()`][] or [`tls.connect()`][] options can be provided.
-* `listener` {Function}
+* `listener` {Function} Will be registered as a one-time listener of the
+  [`'connect'`][] event.
 * Returns: {ClientHttp2Session}
 
 Returns a `ClientHttp2Session` instance.
@@ -3466,6 +3467,7 @@ following additional properties:
 [Stream]: stream.html#stream_stream
 [Using `options.selectPadding()`]: #http2_using_options_selectpadding
 [`'checkContinue'`]: #http2_event_checkcontinue
+[`'connect'`]: #http2_event_connect
 [`'request'`]: #http2_event_request
 [`'unknownProtocol'`]: #http2_event_unknownprotocol
 [`ClientHttp2Stream`]: #http2_class_clienthttp2stream