Skip to content

doc: improve documentation for raw headers in HTTP/2 APIs #59633

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

Jump to bottom
Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

doc: improve documentation for raw headers in HTTP/2 APIs #59633

wants to merge 1 commit into from

Conversation

pimterry
Copy link
Member

  • The headers and response events include the raw headers as a 3rd argument, but this wasn't noted in the docs at all
  • Many places in here now support raw headers, and repeatedly re-explain the structure in each instance. This is now defined separately and linked as a standard type, like the normal HTTP/2 headers object.

@nodejs-github-bot
Copy link
Collaborator

Review requested:

  • @nodejs/http
  • @nodejs/http2
  • @nodejs/net
  • @nodejs/web-infra

@nodejs-github-bot nodejs-github-bot added doc Issues and PRs related to the documentations. tools Issues and PRs related to the tools directory. labels Aug 26, 2025
RafaelGSS
RafaelGSS approved these changes Aug 26, 2025
View reviewed changes
doc/api/http2.md
@@ -3456,6 +3456,21 @@ server.on('stream', (stream, headers) => {
});
```

#### Raw headers
Copy link
Member

Choose a reason for hiding this comment

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

Nit, maybe add a code sample?

Copy link
Member

Choose a reason for hiding this comment

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

+1

@Flarna Flarna added the http2 Issues or PRs related to the http2 subsystem. label Aug 26, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ovflowd ovflowd ovflowd left review comments

@lpinca lpinca lpinca approved these changes

@Flarna Flarna Flarna approved these changes

@RafaelGSS RafaelGSS RafaelGSS approved these changes

@RaisinTen RaisinTen RaisinTen approved these changes

Assignees
No one assigned
Labels
doc Issues and PRs related to the documentations. http2 Issues or PRs related to the http2 subsystem. tools Issues and PRs related to the tools directory.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
7 participants
@pimterry @nodejs-github-bot @lpinca @ovflowd @Flarna @RafaelGSS @RaisinTen