Skip to content

Commit 24a77ae

Browse files
lpincatargos
authored andcommitted
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 <me@silverwind.io> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Yongsheng Zhang <zyszys98@gmail.com>
1 parent 4c333f4 commit 24a77ae

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

doc/api/http2.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -2206,7 +2206,8 @@ changes:
22062206
instance passed to `connect` and the `options` object, and returns any
22072207
[`Duplex`][] stream that is to be used as the connection for this session.
22082208
* ...: Any [`net.connect()`][] or [`tls.connect()`][] options can be provided.
2209-
* `listener` {Function}
2209+
* `listener` {Function} Will be registered as a one-time listener of the
2210+
[`'connect'`][] event.
22102211
* Returns: {ClientHttp2Session}
22112212

22122213
Returns a `ClientHttp2Session` instance.
@@ -3466,6 +3467,7 @@ following additional properties:
34663467
[Stream]: stream.html#stream_stream
34673468
[Using `options.selectPadding()`]: #http2_using_options_selectpadding
34683469
[`'checkContinue'`]: #http2_event_checkcontinue
3470+
[`'connect'`]: #http2_event_connect
34693471
[`'request'`]: #http2_event_request
34703472
[`'unknownProtocol'`]: #http2_event_unknownprotocol
34713473
[`ClientHttp2Stream`]: #http2_class_clienthttp2stream

0 commit comments

Comments
 (0)