Skip to content

Commit

Permalink
doc: alphabetize http response properties
Browse files Browse the repository at this point in the history
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 <benjamingr@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
  • Loading branch information
Trott authored and targos committed May 1, 2021
1 parent afb9534 commit 6293aea
Showing 1 changed file with 19 additions and 19 deletions.
38 changes: 19 additions & 19 deletions doc/api/http2.md
Expand Up @@ -3234,6 +3234,25 @@ deprecated: v13.0.0

See [`response.socket`][].

#### `response.createPushResponse(headers, callback)`
<!-- YAML
added: v8.4.0
-->

* `headers` {HTTP/2 Headers Object} An object describing the headers
* `callback` {Function} Called once `http2stream.pushStream()` is finished,
or either when the attempt to create the pushed `Http2Stream` has failed or
has been rejected, or the state of `Http2ServerRequest` is closed prior to
calling the `http2stream.pushStream()` method
* `err` {Error}
* `res` {http2.Http2ServerResponse} The newly-created `Http2ServerResponse`
object

Call [`http2stream.pushStream()`][] with the given headers, and wrap the
given [`Http2Stream`][] on a newly created `Http2ServerResponse` as the callback
parameter if successful. When `Http2ServerRequest` is closed, the callback is
called with an error `ERR_HTTP2_INVALID_STREAM`.

#### `response.end([data[, encoding]][, callback])`
<!-- YAML
added: v8.4.0
Expand Down Expand Up @@ -3631,25 +3650,6 @@ const server = http2.createServer((req, res) => {
Attempting to set a header field name or value that contains invalid characters
will result in a [`TypeError`][] being thrown.

#### `response.createPushResponse(headers, callback)`
<!-- YAML
added: v8.4.0
-->

* `headers` {HTTP/2 Headers Object} An object describing the headers
* `callback` {Function} Called once `http2stream.pushStream()` is finished,
or either when the attempt to create the pushed `Http2Stream` has failed or
has been rejected, or the state of `Http2ServerRequest` is closed prior to
calling the `http2stream.pushStream()` method
* `err` {Error}
* `res` {http2.Http2ServerResponse} The newly-created `Http2ServerResponse`
object

Call [`http2stream.pushStream()`][] with the given headers, and wrap the
given [`Http2Stream`][] on a newly created `Http2ServerResponse` as the callback
parameter if successful. When `Http2ServerRequest` is closed, the callback is
called with an error `ERR_HTTP2_INVALID_STREAM`.

## Collecting HTTP/2 performance metrics

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

0 comments on commit 6293aea

Please sign in to comment.