Skip to content

Commit

Permalink
doc: fix http and http2 writeEarlyHints() parameter
Browse files Browse the repository at this point in the history
Both http and http2 `response.writeEarlyHints()` take an object,
not an array, as their first parameter. For http, this was updated in
the examples via #44820 except for the final example, which this
patch fixes.
The doc for the http2 version was not touched in #44820 although
I am pretty sure from skimming the code that it behaves identically
to http, and so propose to change its doc as well.
Finally, some bogus headline levels are fixed in http2 docs.

PR-URL: #45000
Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com>
  • Loading branch information
meyfa authored and danielleadams committed Dec 30, 2022
1 parent 9a4fab9 commit 4e0dfd9
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 8 deletions.
4 changes: 3 additions & 1 deletion doc/api/http.md
Original file line number Diff line number Diff line change
Expand Up @@ -2162,7 +2162,9 @@ response.writeEarlyHints({
});

const earlyHintsCallback = () => console.log('early hints message sent');
response.writeEarlyHints(earlyHintsLinks, earlyHintsCallback);
response.writeEarlyHints({
'link': earlyHintsLinks,
}, earlyHintsCallback);
```

### `response.writeHead(statusCode[, statusMessage][, headers])`
Expand Down
18 changes: 11 additions & 7 deletions doc/api/http2.md
Original file line number Diff line number Diff line change
Expand Up @@ -3773,7 +3773,7 @@ Removes a header that has been queued for implicit sending.
response.removeHeader('Content-Encoding');
```

### `response.req`
#### `response.req`

<!-- YAML
added: v15.7.0
Expand Down Expand Up @@ -3991,30 +3991,34 @@ Sends a status `100 Continue` to the client, indicating that the request body
should be sent. See the [`'checkContinue'`][] event on `Http2Server` and
`Http2SecureServer`.

### `response.writeEarlyHints(links)`
#### `response.writeEarlyHints(hints)`

<!-- YAML
added: v18.11.0
-->

* `links` {string|Array}
* `hints` {Object}

Sends a status `103 Early Hints` to the client with a Link header,
indicating that the user agent can preload/preconnect the linked resources.
The `links` can be a string or an array of strings containing the values
of the `Link` header.
The `hints` is an object containing the values of headers to be sent with
early hints message.

**Example**

```js
const earlyHintsLink = '</styles.css>; rel=preload; as=style';
response.writeEarlyHints(earlyHintsLink);
response.writeEarlyHints({
'link': earlyHintsLink,
});

const earlyHintsLinks = [
'</styles.css>; rel=preload; as=style',
'</scripts.js>; rel=preload; as=script',
];
response.writeEarlyHints(earlyHintsLinks);
response.writeEarlyHints({
'link': earlyHintsLinks,
});
```

#### `response.writeHead(statusCode[, statusMessage][, headers])`
Expand Down

0 comments on commit 4e0dfd9

Please sign in to comment.