Skip to content

Commit 9a4a8c1

Browse files
vsemozhetbytMylesBorins
authored andcommitted
doc: unify type linkification
Backport-PR-URL: #20456 PR-URL: #18407 Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Jon Moss <me@jonathanmoss.me> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
1 parent 15023c7 commit 9a4a8c1

File tree

1 file changed

+35
-35
lines changed

1 file changed

+35
-35
lines changed

doc/api/http2.md

+35-35
Original file line numberDiff line numberDiff line change
@@ -229,8 +229,8 @@ added: v8.4.0
229229

230230
The `'stream'` event is emitted when a new `Http2Stream` is created. When
231231
invoked, the handler function will receive a reference to the `Http2Stream`
232-
object, a [Headers Object][], and numeric flags associated with the creation
233-
of the stream.
232+
object, a [HTTP2 Headers Object][], and numeric flags associated with the
233+
creation of the stream.
234234

235235
```js
236236
const http2 = require('http2');
@@ -382,7 +382,7 @@ Transmits a `GOAWAY` frame to the connected peer *without* shutting down the
382382
added: v8.4.0
383383
-->
384384

385-
* Value: {[Settings Object][]}
385+
* Value: {HTTP2 Settings Object}
386386

387387
A prototype-less object describing the current local settings of this
388388
`Http2Session`. The local settings are local to *this* `Http2Session` instance.
@@ -461,7 +461,7 @@ instance's underlying [`net.Socket`].
461461
added: v8.4.0
462462
-->
463463

464-
* Value: {[Settings Object][]}
464+
* Value: {HTTP2 Settings Object}
465465

466466
A prototype-less object describing the current remote settings of this
467467
`Http2Session`. The remote settings are set by the *connected* HTTP/2 peer.
@@ -570,8 +570,8 @@ An object describing the current status of this `Http2Session`.
570570
added: v8.4.0
571571
-->
572572

573-
* `settings` {[Settings Object][]}
574-
* Returns: {undefined}
573+
* `settings` {HTTP2 Settings Object}
574+
* Returns {undefined}
575575

576576
Updates the current local settings for this `Http2Session` and sends a new
577577
`SETTINGS` frame to the connected HTTP/2 peer.
@@ -707,7 +707,7 @@ client.on('altsvc', (alt, origin, stream) => {
707707
added: v8.4.0
708708
-->
709709

710-
* `headers` {[Headers Object][]}
710+
* `headers` {HTTP2 Headers Object}
711711
* `options` {Object}
712712
* `endStream` {boolean} `true` if the `Http2Stream` *writable* side should
713713
be closed initially, such as when sending a `GET` request that should not
@@ -895,7 +895,7 @@ added: v8.4.0
895895

896896
The `'trailers'` event is emitted when a block of headers associated with
897897
trailing header fields is received. The listener callback is passed the
898-
[Headers Object][] and flags associated with the headers.
898+
[HTTP2 Headers Object][] and flags associated with the headers.
899899

900900
```js
901901
stream.on('trailers', (headers, flags) => {
@@ -994,7 +994,7 @@ calling `http2stream.close()`, or `http2stream.destroy()`. Will be
994994
added: REPLACEME
995995
-->
996996

997-
* Value: {[Headers Object][]}
997+
* Value: {HTTP2 Headers Object}
998998

999999
An object containing the outbound headers sent for this `Http2Stream`.
10001000

@@ -1003,7 +1003,7 @@ An object containing the outbound headers sent for this `Http2Stream`.
10031003
added: REPLACEME
10041004
-->
10051005

1006-
* Value: {[Headers Object][]\[\]}
1006+
* Value: {HTTP2 Headers Object[]}
10071007

10081008
An array of objects containing the outbound informational (additional) headers
10091009
sent for this `Http2Stream`.
@@ -1013,7 +1013,7 @@ sent for this `Http2Stream`.
10131013
added: REPLACEME
10141014
-->
10151015

1016-
* Value: {[Headers Object][]}
1016+
* Value: {HTTP2 Headers Object}
10171017

10181018
An object containing the outbound trailers sent for this this `HttpStream`.
10191019

@@ -1096,8 +1096,8 @@ added: v8.4.0
10961096

10971097
The `'headers'` event is emitted when an additional block of headers is received
10981098
for a stream, such as when a block of `1xx` informational headers is received.
1099-
The listener callback is passed the [Headers Object][] and flags associated with
1100-
the headers.
1099+
The listener callback is passed the [HTTP2 Headers Object][] and flags
1100+
associated with the headers.
11011101

11021102
```js
11031103
stream.on('headers', (headers, flags) => {
@@ -1111,8 +1111,8 @@ added: v8.4.0
11111111
-->
11121112

11131113
The `'push'` event is emitted when response headers for a Server Push stream
1114-
are received. The listener callback is passed the [Headers Object][] and flags
1115-
associated with the headers.
1114+
are received. The listener callback is passed the [HTTP2 Headers Object][] and
1115+
flags associated with the headers.
11161116

11171117
```js
11181118
stream.on('push', (headers, flags) => {
@@ -1128,7 +1128,7 @@ added: v8.4.0
11281128
The `'response'` event is emitted when a response `HEADERS` frame has been
11291129
received for this stream from the connected HTTP/2 server. The listener is
11301130
invoked with two arguments: an Object containing the received
1131-
[Headers Object][], and flags associated with the headers.
1131+
[HTTP2 Headers Object][], and flags associated with the headers.
11321132

11331133
For example:
11341134

@@ -1158,7 +1158,7 @@ provide additional methods such as `http2stream.pushStream()` and
11581158
added: v8.4.0
11591159
-->
11601160

1161-
* `headers` {[Headers Object][]}
1161+
* `headers` {HTTP2 Headers Object}
11621162
* Returns: {undefined}
11631163

11641164
Sends an additional informational `HEADERS` frame to the connected HTTP/2 peer.
@@ -1189,7 +1189,7 @@ accepts push streams, `false` otherwise. Settings are the same for every
11891189
added: v8.4.0
11901190
-->
11911191

1192-
* `headers` {[Headers Object][]}
1192+
* `headers` {HTTP2 Headers Object}
11931193
* `options` {Object}
11941194
* `exclusive` {boolean} When `true` and `parent` identifies a parent Stream,
11951195
the created stream is made the sole direct dependency of the parent, with
@@ -1200,9 +1200,9 @@ added: v8.4.0
12001200
* `callback` {Function} Callback that is called once the push stream has been
12011201
initiated.
12021202
* `err` {Error}
1203-
* `pushStream` {[`ServerHttp2Stream`][]} The returned pushStream object.
1204-
* `headers` {[Headers Object][]} Headers object the pushStream was initiated
1205-
with.
1203+
* `pushStream` {ServerHttp2Stream} The returned pushStream object.
1204+
* `headers` {HTTP2 Headers Object} Headers object the pushStream was
1205+
initiated with.
12061206
* Returns: {undefined}
12071207

12081208
Initiates a push stream. The callback is invoked with the new `Http2Stream`
@@ -1232,7 +1232,7 @@ a `weight` value to `http2stream.priority` with the `silent` option set to
12321232
added: v8.4.0
12331233
-->
12341234

1235-
* `headers` {[Headers Object][]}
1235+
* `headers` {HTTP2 Headers Object}
12361236
* `options` {Object}
12371237
* `endStream` {boolean} Set to `true` to indicate that the response will not
12381238
include payload data.
@@ -1278,7 +1278,7 @@ added: v8.4.0
12781278
-->
12791279

12801280
* `fd` {number} A readable file descriptor.
1281-
* `headers` {[Headers Object][]}
1281+
* `headers` {HTTP2 Headers Object}
12821282
* `options` {Object}
12831283
* `statCheck` {Function}
12841284
* `getTrailers` {Function} Callback function invoked to collect trailer
@@ -1362,7 +1362,7 @@ added: v8.4.0
13621362
-->
13631363

13641364
* `path` {string|Buffer|URL}
1365-
* `headers` {[Headers Object][]}
1365+
* `headers` {HTTP2 Headers Object}
13661366
* `options` {Object}
13671367
* `statCheck` {Function}
13681368
* `onError` {Function} Callback function invoked in the case of an
@@ -1728,7 +1728,7 @@ changes:
17281728
* `selectPadding` {Function} When `options.paddingStrategy` is equal to
17291729
`http2.constants.PADDING_STRATEGY_CALLBACK`, provides the callback function
17301730
used to determine the padding. See [Using options.selectPadding][].
1731-
* `settings` {[Settings Object][]} The initial settings to send to the
1731+
* `settings` {HTTP2 Settings Object} The initial settings to send to the
17321732
remote peer upon connection.
17331733
* `onRequestHandler` {Function} See [Compatibility API][]
17341734
* Returns: {Http2Server}
@@ -1815,7 +1815,7 @@ changes:
18151815
* `selectPadding` {Function} When `options.paddingStrategy` is equal to
18161816
`http2.constants.PADDING_STRATEGY_CALLBACK`, provides the callback function
18171817
used to determine the padding. See [Using options.selectPadding][].
1818-
* `settings` {[Settings Object][]} The initial settings to send to the
1818+
* `settings` {HTTP2 Settings Object} The initial settings to send to the
18191819
remote peer upon connection.
18201820
* ...: Any [`tls.createServer()`][] options can be provided. For
18211821
servers, the identity options (`pfx` or `key`/`cert`) are usually required.
@@ -1911,7 +1911,7 @@ changes:
19111911
* `selectPadding` {Function} When `options.paddingStrategy` is equal to
19121912
`http2.constants.PADDING_STRATEGY_CALLBACK`, provides the callback function
19131913
used to determine the padding. See [Using options.selectPadding][].
1914-
* `settings` {[Settings Object][]} The initial settings to send to the
1914+
* `settings` {HTTP2 Settings Object} The initial settings to send to the
19151915
remote peer upon connection.
19161916
* `createConnection` {Function} An optional callback that receives the `URL`
19171917
instance passed to `connect` and the `options` object, and returns any
@@ -1964,7 +1964,7 @@ a given number of milliseconds set using `http2server.setTimeout()`.
19641964
added: v8.4.0
19651965
-->
19661966

1967-
* Returns: {[Settings Object][]}
1967+
* Returns: {HTTP2 Settings Object}
19681968

19691969
Returns an object containing the default settings for an `Http2Session`
19701970
instance. This method returns a new object instance every time it is called
@@ -1975,7 +1975,7 @@ so instances returned may be safely modified for use.
19751975
added: v8.4.0
19761976
-->
19771977

1978-
* `settings` {[Settings Object][]}
1978+
* `settings` {HTTP2 Settings Object}
19791979
* Returns: {Buffer}
19801980

19811981
Returns a `Buffer` instance containing serialized representation of the given
@@ -1997,10 +1997,10 @@ added: v8.4.0
19971997
-->
19981998

19991999
* `buf` {Buffer|Uint8Array} The packed settings.
2000-
* Returns: {[Settings Object][]}
2000+
* Returns: {HTTP2 Settings Object}
20012001

2002-
Returns a [Settings Object][] containing the deserialized settings from the
2003-
given `Buffer` as generated by `http2.getPackedSettings()`.
2002+
Returns a [HTTP2 Settings Object][] containing the deserialized settings from
2003+
the given `Buffer` as generated by `http2.getPackedSettings()`.
20042004

20052005
### Headers Object
20062006

@@ -2372,7 +2372,7 @@ Example:
23722372
console.log(request.headers);
23732373
```
23742374

2375-
See [Headers Object][].
2375+
See [HTTP2 Headers Object][].
23762376

23772377
*Note*: In HTTP/2, the request path, hostname, protocol, and method are
23782378
represented as special headers prefixed with the `:` character (e.g. `':path'`).
@@ -3094,13 +3094,13 @@ following additional properties:
30943094
[Compatibility API]: #http2_compatibility_api
30953095
[HTTP/1]: http.html
30963096
[HTTP/2]: https://tools.ietf.org/html/rfc7540
3097+
[HTTP2 Headers Object]: #http2_headers_object
3098+
[HTTP2 Settings Object]: #http2_settings_object
30973099
[HTTPS]: https.html
3098-
[Headers Object]: #http2_headers_object
30993100
[Http2Session and Sockets]: #http2_http2session_and_sockets
31003101
[Performance Observer]: perf_hooks.html
31013102
[Readable Stream]: stream.html#stream_class_stream_readable
31023103
[RFC 7838]: https://tools.ietf.org/html/rfc7838
3103-
[Settings Object]: #http2_settings_object
31043104
[Using options.selectPadding]: #http2_using_options_selectpadding
31053105
[Writable Stream]: stream.html#stream_writable_streams
31063106
[`'checkContinue'`]: #http2_event_checkcontinue

0 commit comments

Comments
 (0)