Skip to content

doc: Improve doc for Http2 headers object #21296

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

Closed
Flarna wants to merge 3 commits into from
Closed

doc: Improve doc for Http2 headers object #21296

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
972c2df
doc: Improve doc for Http2 headers object
Flarna Jun 12, 2018
6129c5b
Update http2.md
Trott Jun 12, 2018
3c93f26
fix review finding - add colon
Flarna Jun 14, 2018
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
17 changes: 17 additions & 0 deletions doc/api/http2.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2118,6 +2118,23 @@ means that normal JavaScript object methods such as
`Object.prototype.toString()` and `Object.prototype.hasOwnProperty()` will
not work.

For incoming headers:
* The `:status` header is converted to `number`.
* Duplicates of `:status`, `:method`, `:authority`, `:scheme`, `:path`,
`age`, `authorization`, `access-control-allow-credentials`,
`access-control-max-age`, `access-control-request-method`, `content-encoding`,
`content-language`, `content-length`, `content-location`, `content-md5`,
`content-range`, `content-type`, `date`, `dnt`, `etag`, `expires`, `from`,
`if-match`, `if-modified-since`, `if-none-match`, `if-range`,
`if-unmodified-since`, `last-modified`, `location`, `max-forwards`,
`proxy-authorization`, `range`, `referer`,`retry-after`, `tk`,
`upgrade-insecure-requests`, `user-agent` or `x-content-type-options` are
discarded.
* `set-cookie` is a string if present once or an array in case duplicates
are present.
* `cookie` the values are joined together with '; '.
Copy link
Copy Markdown
Contributor

@vsemozhetbyt vsemozhetbyt Jun 13, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe a colon after `cookie`?

Copy link
Copy Markdown
Member Author

@Flarna Flarna Jun 14, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

* For all other headers, the values are joined together with ', '.

```js
const http2 = require('http2');
const server = http2.createServer();
Expand Down