Skip to content

Commit 6293aea

Browse files
Trotttargos
authored andcommitted
doc: alphabetize http response properties
All the properties are already in alphabetical order except for createPushResponse(). Move that property to the alphabetical location in the list. PR-URL: #36631 Reviewed-By: Benjamin Gruenbaum <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
1 parent afb9534 commit 6293aea

File tree

1 file changed

+19
-19
lines changed

1 file changed

+19
-19
lines changed

doc/api/http2.md

+19-19
Original file line numberDiff line numberDiff line change
@@ -3234,6 +3234,25 @@ deprecated: v13.0.0
32343234

32353235
See [`response.socket`][].
32363236

3237+
#### `response.createPushResponse(headers, callback)`
3238+
<!-- YAML
3239+
added: v8.4.0
3240+
-->
3241+
3242+
* `headers` {HTTP/2 Headers Object} An object describing the headers
3243+
* `callback` {Function} Called once `http2stream.pushStream()` is finished,
3244+
or either when the attempt to create the pushed `Http2Stream` has failed or
3245+
has been rejected, or the state of `Http2ServerRequest` is closed prior to
3246+
calling the `http2stream.pushStream()` method
3247+
* `err` {Error}
3248+
* `res` {http2.Http2ServerResponse} The newly-created `Http2ServerResponse`
3249+
object
3250+
3251+
Call [`http2stream.pushStream()`][] with the given headers, and wrap the
3252+
given [`Http2Stream`][] on a newly created `Http2ServerResponse` as the callback
3253+
parameter if successful. When `Http2ServerRequest` is closed, the callback is
3254+
called with an error `ERR_HTTP2_INVALID_STREAM`.
3255+
32373256
#### `response.end([data[, encoding]][, callback])`
32383257
<!-- YAML
32393258
added: v8.4.0
@@ -3631,25 +3650,6 @@ const server = http2.createServer((req, res) => {
36313650
Attempting to set a header field name or value that contains invalid characters
36323651
will result in a [`TypeError`][] being thrown.
36333652

3634-
#### `response.createPushResponse(headers, callback)`
3635-
<!-- YAML
3636-
added: v8.4.0
3637-
-->
3638-
3639-
* `headers` {HTTP/2 Headers Object} An object describing the headers
3640-
* `callback` {Function} Called once `http2stream.pushStream()` is finished,
3641-
or either when the attempt to create the pushed `Http2Stream` has failed or
3642-
has been rejected, or the state of `Http2ServerRequest` is closed prior to
3643-
calling the `http2stream.pushStream()` method
3644-
* `err` {Error}
3645-
* `res` {http2.Http2ServerResponse} The newly-created `Http2ServerResponse`
3646-
object
3647-
3648-
Call [`http2stream.pushStream()`][] with the given headers, and wrap the
3649-
given [`Http2Stream`][] on a newly created `Http2ServerResponse` as the callback
3650-
parameter if successful. When `Http2ServerRequest` is closed, the callback is
3651-
called with an error `ERR_HTTP2_INVALID_STREAM`.
3652-
36533653
## Collecting HTTP/2 performance metrics
36543654

36553655
The [Performance Observer][] API can be used to collect basic performance

0 commit comments

Comments
 (0)