Skip to content

Commit f27a254

Browse files
MaleDongtargos
MaleDong
authored andcommitted
doc: make createPushResponse() more detailled
We don't know what will return when successful or failure for the callback of the function. So this commit makes it more detailled. PR-URL: #22366 Refs: #22322 Reviewed-By: Matteo Collina <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]>
1 parent fc1259b commit f27a254

File tree

1 file changed

+10
-6
lines changed

1 file changed

+10
-6
lines changed

doc/api/http2.md

+10-6
Original file line numberDiff line numberDiff line change
@@ -3150,13 +3150,17 @@ will result in a [`TypeError`][] being thrown.
31503150
added: v8.4.0
31513151
-->
31523152
* `headers` {HTTP/2 Headers Object} An object describing the headers
3153-
* `callback` {Function}
3154-
3155-
Call [`http2stream.pushStream()`][] with the given headers, and wraps the
3156-
given newly created [`Http2Stream`] on `Http2ServerResponse`.
3153+
* `callback` {Function} Called once `http2stream.pushStream()` is finished,
3154+
or either when the attempt to create the pushed `Http2Stream` has failed or
3155+
has been rejected, or the state of `Http2ServerRequest` is closed prior to
3156+
calling the `http2stream.pushStream()` method
3157+
* `err` {Error}
3158+
* `stream` {ServerHttp2Stream} The newly-created `ServerHttp2Stream` object
31573159

3158-
The callback will be called with an error with code `ERR_HTTP2_INVALID_STREAM`
3159-
if the stream is closed.
3160+
Call [`http2stream.pushStream()`][] with the given headers, and wrap the
3161+
given [`Http2Stream`] on a newly created `Http2ServerResponse` as the callback
3162+
parameter if successful. When `Http2ServerRequest` is closed, the callback is
3163+
called with an error `ERR_HTTP2_INVALID_STREAM`.
31603164

31613165
## Collecting HTTP/2 Performance Metrics
31623166

0 commit comments

Comments
 (0)