diff options
| author | Nick Schonning <nschonni@gmail.com> | 2019-08-28 23:23:28 -0400 |
|---|---|---|
| committer | Rich Trott <rtrott@gmail.com> | 2019-08-31 15:29:39 -0700 |
| commit | ee8f02b0d752ecf2dfa044deb246e75283d1ca1d (patch) | |
| tree | 3f415bd07cd517ba6bb6b7abe0bf5bc039138daa /doc/api | |
| parent | 9a46cfc33796a5effade4a0c6de95807f1fca7ad (diff) | |
| download | android-node-v8-ee8f02b0d752ecf2dfa044deb246e75283d1ca1d.tar.gz android-node-v8-ee8f02b0d752ecf2dfa044deb246e75283d1ca1d.tar.bz2 android-node-v8-ee8f02b0d752ecf2dfa044deb246e75283d1ca1d.zip | |
doc: format http2 anchor link and reference
Some links were flagged as empty links by Markdownlint MD042.
The HttpServerResponse anchor link was also not defined.
PR-URL: https://github.com/nodejs/node/pull/29362
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Diffstat (limited to 'doc/api')
| -rw-r--r-- | doc/api/http2.md | 15 |
1 files changed, 8 insertions, 7 deletions
diff --git a/doc/api/http2.md b/doc/api/http2.md index 6c280f4e86..7bcb567d98 100644 --- a/doc/api/http2.md +++ b/doc/api/http2.md @@ -2585,8 +2585,8 @@ In order to create a mixed [HTTPS][] and HTTP/2 server, refer to the [ALPN negotiation][] section. Upgrading from non-tls HTTP/1 servers is not supported. -The HTTP/2 compatibility API is composed of [`Http2ServerRequest`]() and -[`Http2ServerResponse`](). They aim at API compatibility with HTTP/1, but +The HTTP/2 compatibility API is composed of [`Http2ServerRequest`][] and +[`Http2ServerResponse`][]. They aim at API compatibility with HTTP/1, but they do not hide the differences between the protocols. As an example, the status message for HTTP codes is ignored. @@ -2817,12 +2817,12 @@ added: v8.4.0 * `callback` {Function} * Returns: {http2.Http2ServerRequest} -Sets the [`Http2Stream`]()'s timeout value to `msecs`. If a callback is +Sets the [`Http2Stream`][]'s timeout value to `msecs`. If a callback is provided, then it is added as a listener on the `'timeout'` event on the response object. If no `'timeout'` listener is added to the request, the response, or -the server, then [`Http2Stream`]()s are destroyed when they time out. If a +the server, then [`Http2Stream`][]s are destroyed when they time out. If a handler is assigned to the request, the response, or the server's `'timeout'` events, timed out sockets must be handled explicitly. @@ -2951,7 +2951,7 @@ passed as the second parameter to the [`'request'`][] event. added: v8.4.0 --> -Indicates that the underlying [`Http2Stream`]() was terminated before +Indicates that the underlying [`Http2Stream`][] was terminated before [`response.end()`][] was called or able to flush. #### Event: 'finish' @@ -3182,12 +3182,12 @@ added: v8.4.0 * `callback` {Function} * Returns: {http2.Http2ServerResponse} -Sets the [`Http2Stream`]()'s timeout value to `msecs`. If a callback is +Sets the [`Http2Stream`][]'s timeout value to `msecs`. If a callback is provided, then it is added as a listener on the `'timeout'` event on the response object. If no `'timeout'` listener is added to the request, the response, or -the server, then [`Http2Stream`]()s are destroyed when they time out. If a +the server, then [`Http2Stream`][]s are destroyed when they time out. If a handler is assigned to the request, the response, or the server's `'timeout'` events, timed out sockets must be handled explicitly. @@ -3478,6 +3478,7 @@ following additional properties: [`ClientHttp2Stream`]: #http2_class_clienthttp2stream [`Duplex`]: stream.html#stream_class_stream_duplex [`Http2ServerRequest`]: #http2_class_http2_http2serverrequest +[`Http2ServerResponse`]: #class-http2http2serverresponse [`Http2Session` and Sockets]: #http2_http2session_and_sockets [`Http2Stream`]: #http2_class_http2stream [`ServerHttp2Stream`]: #http2_class_serverhttp2stream |