Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: fix some links in http2.md #15481

Closed
wants to merge 1 commit into from
Closed

doc: fix some links in http2.md #15481

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 8 additions & 7 deletions doc/api/http2.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,8 @@ in order to use the `'http2'` module.

The Core API provides a low-level interface designed specifically around
support for HTTP/2 protocol features. It is specifically *not* designed for
compatibility with the existing [HTTP/1][] module API. However, the [Compatibility API][] is.
compatibility with the existing [HTTP/1][] module API. However,
the [Compatibility API][] is.

The following illustrates a simple, plain-text HTTP/2 server using the
Core API:
Expand Down Expand Up @@ -1305,7 +1306,7 @@ added: v8.4.0
* `response` {http2.Http2ServerResponse}

Emitted each time there is a request. Note that there may be multiple requests
per session. See the [Compatibility API](compatiblity-api).
per session. See the [Compatibility API][].

#### Event: 'timeout'
<!-- YAML
Expand Down Expand Up @@ -1413,7 +1414,7 @@ added: v8.4.0
* `response` {http2.Http2ServerResponse}

Emitted each time there is a request. Note that there may be multiple requests
per session. See the [Compatibility API](compatiblity-api).
per session. See the [Compatibility API][].

#### Event: 'timeout'
<!-- YAML
Expand Down Expand Up @@ -1915,8 +1916,8 @@ req.end('Jane');

The Compatibility API has the goal of providing a similar developer experience
of HTTP/1 when using HTTP/2, making it possible to develop applications
that supports both [HTTP/1](HTTP/1) and HTTP/2. This API targets only the
**public API** of the [HTTP/1](HTTP/1), however many modules uses internal
that supports both [HTTP/1][] and HTTP/2. This API targets only the
**public API** of the [HTTP/1][], however many modules uses internal
methods or state, and those _are not supported_ as it is a completely
different implementation.

Expand Down Expand Up @@ -1976,7 +1977,7 @@ function onRequest(req, res) {
}
```

The `'request'` event works identically on both [HTTPS](https) and
The `'request'` event works identically on both [HTTPS][] and
HTTP/2.

### Class: http2.Http2ServerRequest
Expand Down Expand Up @@ -2605,7 +2606,7 @@ added: v8.4.0
Sends a response header to the request. The status code is a 3-digit HTTP
status code, like `404`. The last argument, `headers`, are the response headers.

For compatibility with [HTTP/1](), a human-readable `statusMessage` may be
For compatibility with [HTTP/1][], a human-readable `statusMessage` may be
passed as the second argument. However, because the `statusMessage` has no
meaning within HTTP/2, the argument will have no effect and a process warning
will be emitted.
Expand Down