doc: document http2 header constants#64548

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

Merged
nodejs-github-bot merged 1 commit into from
Aug 14, 2026
Merged

doc: document http2 header constants #64548

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
151 changes: 145 additions & 6 deletions doc/api/http2.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -3404,6 +3404,142 @@ client.close();
added: v8.4.0
-->

#### Header name constants

The `HTTP2_HEADER_*` constants provide names for HTTP/2 pseudo-headers and
known HTTP header names. Using these string constants is optional. For example,
`http2.constants.HTTP2_HEADER_CONTENT_TYPE` is equal to `'content-type'`.
For APIs that accept regular header names,
`http2.constants.HTTP2_HEADER_CONTENT_TYPE`, `'content-type'`, and
`'Content-Type'` have the same effect; Node.js serializes the name in
lower-case.

Regular header constants can be used with the compatibility API wherever the
corresponding literal header name is accepted. In compatibility API request
handlers, prefer `request.method`, `request.authority`, `request.scheme`, and
`request.url` for the corresponding pseudo-headers. Other incoming
pseudo-headers remain available through `request.headers`. Set response status
through `response.statusCode` or the `statusCode` argument to
`response.writeHead()`. Passing `HTTP2_HEADER_STATUS` (`':status'`) to
`response.setHeader()` or in `response.writeHead()`'s headers object throws
`ERR_HTTP2_PSEUDOHEADER_NOT_ALLOWED`. `HTTP2_HEADER_PROTOCOL` is a request
pseudo-header and cannot be sent in a response.

Incoming header object keys are lower-case, so use a constant or a lower-case
literal when accessing them as object properties. Using a constant does not
change header validation, and the availability of a constant does not imply
that the header is valid in every HTTP/2 context. See [HTTP/2 Headers Object][]
and [Invalid character handling in header names and values][] for details about
header casing and validation.

##### Pseudo-header constants

`HTTP2_HEADER_METHOD`, `HTTP2_HEADER_AUTHORITY`, `HTTP2_HEADER_SCHEME`, and
`HTTP2_HEADER_PATH` identify request pseudo-headers. `HTTP2_HEADER_STATUS`
identifies the response pseudo-header. `HTTP2_HEADER_PROTOCOL` identifies the
extended `CONNECT` request pseudo-header. Pseudo-headers are not permitted in
trailers.

| Constant | Value |
| ---------------------------------------- | -------------- |
| `http2.constants.HTTP2_HEADER_STATUS` | `':status'` |
| `http2.constants.HTTP2_HEADER_METHOD` | `':method'` |
| `http2.constants.HTTP2_HEADER_AUTHORITY` | `':authority'` |
| `http2.constants.HTTP2_HEADER_SCHEME` | `':scheme'` |
| `http2.constants.HTTP2_HEADER_PATH` | `':path'` |
| `http2.constants.HTTP2_HEADER_PROTOCOL` | `':protocol'` |

##### Regular header constants

The `HTTP2_HEADER_CONNECTION`, `HTTP2_HEADER_UPGRADE`,
`HTTP2_HEADER_HTTP2_SETTINGS`, `HTTP2_HEADER_KEEP_ALIVE`,
`HTTP2_HEADER_PROXY_CONNECTION`, and `HTTP2_HEADER_TRANSFER_ENCODING`
constants identify connection-specific headers that HTTP/2 does not permit.
`HTTP2_HEADER_TE` is permitted only when its value is `'trailers'`.

| Constant | Value |
| --------------------------------------------------------------- | ------------------------------------ |
| `http2.constants.HTTP2_HEADER_ACCEPT_ENCODING` | `'accept-encoding'` |
| `http2.constants.HTTP2_HEADER_ACCEPT_LANGUAGE` | `'accept-language'` |
| `http2.constants.HTTP2_HEADER_ACCEPT_RANGES` | `'accept-ranges'` |
| `http2.constants.HTTP2_HEADER_ACCEPT` | `'accept'` |
| `http2.constants.HTTP2_HEADER_ACCESS_CONTROL_ALLOW_CREDENTIALS` | `'access-control-allow-credentials'` |
| `http2.constants.HTTP2_HEADER_ACCESS_CONTROL_ALLOW_HEADERS` | `'access-control-allow-headers'` |
| `http2.constants.HTTP2_HEADER_ACCESS_CONTROL_ALLOW_METHODS` | `'access-control-allow-methods'` |
| `http2.constants.HTTP2_HEADER_ACCESS_CONTROL_ALLOW_ORIGIN` | `'access-control-allow-origin'` |
| `http2.constants.HTTP2_HEADER_ACCESS_CONTROL_EXPOSE_HEADERS` | `'access-control-expose-headers'` |
| `http2.constants.HTTP2_HEADER_ACCESS_CONTROL_REQUEST_HEADERS` | `'access-control-request-headers'` |
| `http2.constants.HTTP2_HEADER_ACCESS_CONTROL_REQUEST_METHOD` | `'access-control-request-method'` |
| `http2.constants.HTTP2_HEADER_AGE` | `'age'` |
| `http2.constants.HTTP2_HEADER_AUTHORIZATION` | `'authorization'` |
| `http2.constants.HTTP2_HEADER_CACHE_CONTROL` | `'cache-control'` |
| `http2.constants.HTTP2_HEADER_CONNECTION` | `'connection'` |
| `http2.constants.HTTP2_HEADER_CONTENT_DISPOSITION` | `'content-disposition'` |
| `http2.constants.HTTP2_HEADER_CONTENT_ENCODING` | `'content-encoding'` |
| `http2.constants.HTTP2_HEADER_CONTENT_LENGTH` | `'content-length'` |
| `http2.constants.HTTP2_HEADER_CONTENT_TYPE` | `'content-type'` |
| `http2.constants.HTTP2_HEADER_COOKIE` | `'cookie'` |
| `http2.constants.HTTP2_HEADER_DATE` | `'date'` |
| `http2.constants.HTTP2_HEADER_ETAG` | `'etag'` |
| `http2.constants.HTTP2_HEADER_FORWARDED` | `'forwarded'` |
| `http2.constants.HTTP2_HEADER_HOST` | `'host'` |
| `http2.constants.HTTP2_HEADER_IF_MODIFIED_SINCE` | `'if-modified-since'` |
| `http2.constants.HTTP2_HEADER_IF_NONE_MATCH` | `'if-none-match'` |
| `http2.constants.HTTP2_HEADER_IF_RANGE` | `'if-range'` |
| `http2.constants.HTTP2_HEADER_LAST_MODIFIED` | `'last-modified'` |
| `http2.constants.HTTP2_HEADER_LINK` | `'link'` |
| `http2.constants.HTTP2_HEADER_LOCATION` | `'location'` |
| `http2.constants.HTTP2_HEADER_RANGE` | `'range'` |
| `http2.constants.HTTP2_HEADER_REFERER` | `'referer'` |
| `http2.constants.HTTP2_HEADER_SERVER` | `'server'` |
| `http2.constants.HTTP2_HEADER_SET_COOKIE` | `'set-cookie'` |
| `http2.constants.HTTP2_HEADER_STRICT_TRANSPORT_SECURITY` | `'strict-transport-security'` |
| `http2.constants.HTTP2_HEADER_TRANSFER_ENCODING` | `'transfer-encoding'` |
| `http2.constants.HTTP2_HEADER_TE` | `'te'` |
| `http2.constants.HTTP2_HEADER_UPGRADE_INSECURE_REQUESTS` | `'upgrade-insecure-requests'` |
| `http2.constants.HTTP2_HEADER_UPGRADE` | `'upgrade'` |
| `http2.constants.HTTP2_HEADER_USER_AGENT` | `'user-agent'` |
| `http2.constants.HTTP2_HEADER_VARY` | `'vary'` |
| `http2.constants.HTTP2_HEADER_X_CONTENT_TYPE_OPTIONS` | `'x-content-type-options'` |
| `http2.constants.HTTP2_HEADER_X_FRAME_OPTIONS` | `'x-frame-options'` |
| `http2.constants.HTTP2_HEADER_KEEP_ALIVE` | `'keep-alive'` |
| `http2.constants.HTTP2_HEADER_PROXY_CONNECTION` | `'proxy-connection'` |
| `http2.constants.HTTP2_HEADER_X_XSS_PROTECTION` | `'x-xss-protection'` |
| `http2.constants.HTTP2_HEADER_ALT_SVC` | `'alt-svc'` |
| `http2.constants.HTTP2_HEADER_CONTENT_SECURITY_POLICY` | `'content-security-policy'` |
| `http2.constants.HTTP2_HEADER_EARLY_DATA` | `'early-data'` |
| `http2.constants.HTTP2_HEADER_EXPECT_CT` | `'expect-ct'` |
| `http2.constants.HTTP2_HEADER_ORIGIN` | `'origin'` |
| `http2.constants.HTTP2_HEADER_PURPOSE` | `'purpose'` |
| `http2.constants.HTTP2_HEADER_TIMING_ALLOW_ORIGIN` | `'timing-allow-origin'` |
| `http2.constants.HTTP2_HEADER_X_FORWARDED_FOR` | `'x-forwarded-for'` |
| `http2.constants.HTTP2_HEADER_PRIORITY` | `'priority'` |
| `http2.constants.HTTP2_HEADER_ACCEPT_CHARSET` | `'accept-charset'` |
| `http2.constants.HTTP2_HEADER_ACCESS_CONTROL_MAX_AGE` | `'access-control-max-age'` |
| `http2.constants.HTTP2_HEADER_ALLOW` | `'allow'` |
| `http2.constants.HTTP2_HEADER_CONTENT_LANGUAGE` | `'content-language'` |
| `http2.constants.HTTP2_HEADER_CONTENT_LOCATION` | `'content-location'` |
| `http2.constants.HTTP2_HEADER_CONTENT_MD5` | `'content-md5'` |
| `http2.constants.HTTP2_HEADER_CONTENT_RANGE` | `'content-range'` |
| `http2.constants.HTTP2_HEADER_DNT` | `'dnt'` |
| `http2.constants.HTTP2_HEADER_EXPECT` | `'expect'` |
| `http2.constants.HTTP2_HEADER_EXPIRES` | `'expires'` |
| `http2.constants.HTTP2_HEADER_FROM` | `'from'` |
| `http2.constants.HTTP2_HEADER_IF_MATCH` | `'if-match'` |
| `http2.constants.HTTP2_HEADER_IF_UNMODIFIED_SINCE` | `'if-unmodified-since'` |
| `http2.constants.HTTP2_HEADER_MAX_FORWARDS` | `'max-forwards'` |
| `http2.constants.HTTP2_HEADER_PREFER` | `'prefer'` |
| `http2.constants.HTTP2_HEADER_PROXY_AUTHENTICATE` | `'proxy-authenticate'` |
| `http2.constants.HTTP2_HEADER_PROXY_AUTHORIZATION` | `'proxy-authorization'` |
| `http2.constants.HTTP2_HEADER_REFRESH` | `'refresh'` |
| `http2.constants.HTTP2_HEADER_RETRY_AFTER` | `'retry-after'` |
| `http2.constants.HTTP2_HEADER_TRAILER` | `'trailer'` |
| `http2.constants.HTTP2_HEADER_TK` | `'tk'` |
| `http2.constants.HTTP2_HEADER_VIA` | `'via'` |
| `http2.constants.HTTP2_HEADER_WARNING` | `'warning'` |
| `http2.constants.HTTP2_HEADER_WWW_AUTHENTICATE` | `'www-authenticate'` |
| `http2.constants.HTTP2_HEADER_HTTP2_SETTINGS` | `'http2-settings'` |

#### Error codes for `RST_STREAM` and `GOAWAY`

| Value | Name | Constant |
Expand DownExpand Up@@ -3970,19 +4106,21 @@ API:
```mjs
import { createServer } from 'node:http2';
const server = createServer((req, res) => {
res.setHeader('Content-Type', 'text/html');
res.setHeader('X-Foo', 'bar');
res.writeHead(200, { 'Content-Type': 'text/plain; charset=utf-8' });
res.writeHead(200, {
'Content-Type': 'text/plain; charset=utf-8',
'X-Foo': 'bar',
});
res.end('ok');
});
```

```cjs
const http2 = require('node:http2');
const server = http2.createServer((req, res) => {
res.setHeader('Content-Type', 'text/html');
res.setHeader('X-Foo', 'bar');
res.writeHead(200, { 'Content-Type': 'text/plain; charset=utf-8' });
res.writeHead(200, {
'Content-Type': 'text/plain; charset=utf-8',
'X-Foo': 'bar',
});
res.end('ok');
});
```
Expand DownExpand Up@@ -5081,6 +5219,7 @@ you need to implement any fall-back behavior yourself.
[HTTP/2 Settings Object]: #settings-object
[HTTP/2 Unencrypted]: https://http2.github.io/faq/#does-http2-require-encryption
[HTTPS]: https.md
[Invalid character handling in header names and values]: #invalid-character-handling-in-header-names-and-values
[Performance Observer]: perf_hooks.md
[RFC 7838]: https://tools.ietf.org/html/rfc7838
[RFC 8336]: https://tools.ietf.org/html/rfc8336
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
doc: document http2 header constants#64548

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

 Merged

nodejs-github-bot
merged 1 commit into

from

Aug 14, 2026
 Merged


doc: document http2 header constants
#64548
 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


151 changes: 145 additions & 6 deletions
doc/api/http2.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3404,6 +3404,142 @@ client.close();
added: v8.4.0
-->

#### Header name constants

The `HTTP2_HEADER_*` constants provide names for HTTP/2 pseudo-headers and
known HTTP header names. Using these string constants is optional. For example,
`http2.constants.HTTP2_HEADER_CONTENT_TYPE` is equal to `'content-type'`.
For APIs that accept regular header names,
`http2.constants.HTTP2_HEADER_CONTENT_TYPE`, `'content-type'`, and
`'Content-Type'` have the same effect; Node.js serializes the name in
lower-case.

Regular header constants can be used with the compatibility API wherever the
corresponding literal header name is accepted. In compatibility API request
handlers, prefer `request.method`, `request.authority`, `request.scheme`, and
`request.url` for the corresponding pseudo-headers. Other incoming
pseudo-headers remain available through `request.headers`. Set response status
through `response.statusCode` or the `statusCode` argument to
`response.writeHead()`. Passing `HTTP2_HEADER_STATUS` (`':status'`) to
`response.setHeader()` or in `response.writeHead()`'s headers object throws
`ERR_HTTP2_PSEUDOHEADER_NOT_ALLOWED`. `HTTP2_HEADER_PROTOCOL` is a request
pseudo-header and cannot be sent in a response.

Incoming header object keys are lower-case, so use a constant or a lower-case
literal when accessing them as object properties. Using a constant does not
change header validation, and the availability of a constant does not imply
that the header is valid in every HTTP/2 context. See [HTTP/2 Headers Object][]
and [Invalid character handling in header names and values][] for details about
header casing and validation.

##### Pseudo-header constants

`HTTP2_HEADER_METHOD`, `HTTP2_HEADER_AUTHORITY`, `HTTP2_HEADER_SCHEME`, and
`HTTP2_HEADER_PATH` identify request pseudo-headers. `HTTP2_HEADER_STATUS`
identifies the response pseudo-header. `HTTP2_HEADER_PROTOCOL` identifies the
extended `CONNECT` request pseudo-header. Pseudo-headers are not permitted in
trailers.

| Constant | Value |
| ---------------------------------------- | -------------- |
| `http2.constants.HTTP2_HEADER_STATUS` | `':status'` |
| `http2.constants.HTTP2_HEADER_METHOD` | `':method'` |
| `http2.constants.HTTP2_HEADER_AUTHORITY` | `':authority'` |
| `http2.constants.HTTP2_HEADER_SCHEME` | `':scheme'` |
| `http2.constants.HTTP2_HEADER_PATH` | `':path'` |
| `http2.constants.HTTP2_HEADER_PROTOCOL` | `':protocol'` |

##### Regular header constants

The `HTTP2_HEADER_CONNECTION`, `HTTP2_HEADER_UPGRADE`,
`HTTP2_HEADER_HTTP2_SETTINGS`, `HTTP2_HEADER_KEEP_ALIVE`,
`HTTP2_HEADER_PROXY_CONNECTION`, and `HTTP2_HEADER_TRANSFER_ENCODING`
constants identify connection-specific headers that HTTP/2 does not permit.
`HTTP2_HEADER_TE` is permitted only when its value is `'trailers'`.

| Constant | Value |
| --------------------------------------------------------------- | ------------------------------------ |
| `http2.constants.HTTP2_HEADER_ACCEPT_ENCODING` | `'accept-encoding'` |
| `http2.constants.HTTP2_HEADER_ACCEPT_LANGUAGE` | `'accept-language'` |
| `http2.constants.HTTP2_HEADER_ACCEPT_RANGES` | `'accept-ranges'` |
| `http2.constants.HTTP2_HEADER_ACCEPT` | `'accept'` |
| `http2.constants.HTTP2_HEADER_ACCESS_CONTROL_ALLOW_CREDENTIALS` | `'access-control-allow-credentials'` |
| `http2.constants.HTTP2_HEADER_ACCESS_CONTROL_ALLOW_HEADERS` | `'access-control-allow-headers'` |
| `http2.constants.HTTP2_HEADER_ACCESS_CONTROL_ALLOW_METHODS` | `'access-control-allow-methods'` |
| `http2.constants.HTTP2_HEADER_ACCESS_CONTROL_ALLOW_ORIGIN` | `'access-control-allow-origin'` |
| `http2.constants.HTTP2_HEADER_ACCESS_CONTROL_EXPOSE_HEADERS` | `'access-control-expose-headers'` |
| `http2.constants.HTTP2_HEADER_ACCESS_CONTROL_REQUEST_HEADERS` | `'access-control-request-headers'` |
| `http2.constants.HTTP2_HEADER_ACCESS_CONTROL_REQUEST_METHOD` | `'access-control-request-method'` |
| `http2.constants.HTTP2_HEADER_AGE` | `'age'` |
| `http2.constants.HTTP2_HEADER_AUTHORIZATION` | `'authorization'` |
| `http2.constants.HTTP2_HEADER_CACHE_CONTROL` | `'cache-control'` |
| `http2.constants.HTTP2_HEADER_CONNECTION` | `'connection'` |
| `http2.constants.HTTP2_HEADER_CONTENT_DISPOSITION` | `'content-disposition'` |
| `http2.constants.HTTP2_HEADER_CONTENT_ENCODING` | `'content-encoding'` |
| `http2.constants.HTTP2_HEADER_CONTENT_LENGTH` | `'content-length'` |
| `http2.constants.HTTP2_HEADER_CONTENT_TYPE` | `'content-type'` |
| `http2.constants.HTTP2_HEADER_COOKIE` | `'cookie'` |
| `http2.constants.HTTP2_HEADER_DATE` | `'date'` |
| `http2.constants.HTTP2_HEADER_ETAG` | `'etag'` |
| `http2.constants.HTTP2_HEADER_FORWARDED` | `'forwarded'` |
| `http2.constants.HTTP2_HEADER_HOST` | `'host'` |
| `http2.constants.HTTP2_HEADER_IF_MODIFIED_SINCE` | `'if-modified-since'` |
| `http2.constants.HTTP2_HEADER_IF_NONE_MATCH` | `'if-none-match'` |
| `http2.constants.HTTP2_HEADER_IF_RANGE` | `'if-range'` |
| `http2.constants.HTTP2_HEADER_LAST_MODIFIED` | `'last-modified'` |
| `http2.constants.HTTP2_HEADER_LINK` | `'link'` |
| `http2.constants.HTTP2_HEADER_LOCATION` | `'location'` |
| `http2.constants.HTTP2_HEADER_RANGE` | `'range'` |
| `http2.constants.HTTP2_HEADER_REFERER` | `'referer'` |
| `http2.constants.HTTP2_HEADER_SERVER` | `'server'` |
| `http2.constants.HTTP2_HEADER_SET_COOKIE` | `'set-cookie'` |
| `http2.constants.HTTP2_HEADER_STRICT_TRANSPORT_SECURITY` | `'strict-transport-security'` |
| `http2.constants.HTTP2_HEADER_TRANSFER_ENCODING` | `'transfer-encoding'` |
| `http2.constants.HTTP2_HEADER_TE` | `'te'` |
| `http2.constants.HTTP2_HEADER_UPGRADE_INSECURE_REQUESTS` | `'upgrade-insecure-requests'` |
| `http2.constants.HTTP2_HEADER_UPGRADE` | `'upgrade'` |
| `http2.constants.HTTP2_HEADER_USER_AGENT` | `'user-agent'` |
| `http2.constants.HTTP2_HEADER_VARY` | `'vary'` |
| `http2.constants.HTTP2_HEADER_X_CONTENT_TYPE_OPTIONS` | `'x-content-type-options'` |
| `http2.constants.HTTP2_HEADER_X_FRAME_OPTIONS` | `'x-frame-options'` |
| `http2.constants.HTTP2_HEADER_KEEP_ALIVE` | `'keep-alive'` |
| `http2.constants.HTTP2_HEADER_PROXY_CONNECTION` | `'proxy-connection'` |
| `http2.constants.HTTP2_HEADER_X_XSS_PROTECTION` | `'x-xss-protection'` |
| `http2.constants.HTTP2_HEADER_ALT_SVC` | `'alt-svc'` |
| `http2.constants.HTTP2_HEADER_CONTENT_SECURITY_POLICY` | `'content-security-policy'` |
| `http2.constants.HTTP2_HEADER_EARLY_DATA` | `'early-data'` |
| `http2.constants.HTTP2_HEADER_EXPECT_CT` | `'expect-ct'` |
| `http2.constants.HTTP2_HEADER_ORIGIN` | `'origin'` |
| `http2.constants.HTTP2_HEADER_PURPOSE` | `'purpose'` |
| `http2.constants.HTTP2_HEADER_TIMING_ALLOW_ORIGIN` | `'timing-allow-origin'` |
| `http2.constants.HTTP2_HEADER_X_FORWARDED_FOR` | `'x-forwarded-for'` |
| `http2.constants.HTTP2_HEADER_PRIORITY` | `'priority'` |
| `http2.constants.HTTP2_HEADER_ACCEPT_CHARSET` | `'accept-charset'` |
| `http2.constants.HTTP2_HEADER_ACCESS_CONTROL_MAX_AGE` | `'access-control-max-age'` |
| `http2.constants.HTTP2_HEADER_ALLOW` | `'allow'` |
| `http2.constants.HTTP2_HEADER_CONTENT_LANGUAGE` | `'content-language'` |
| `http2.constants.HTTP2_HEADER_CONTENT_LOCATION` | `'content-location'` |
| `http2.constants.HTTP2_HEADER_CONTENT_MD5` | `'content-md5'` |
| `http2.constants.HTTP2_HEADER_CONTENT_RANGE` | `'content-range'` |
| `http2.constants.HTTP2_HEADER_DNT` | `'dnt'` |
| `http2.constants.HTTP2_HEADER_EXPECT` | `'expect'` |
| `http2.constants.HTTP2_HEADER_EXPIRES` | `'expires'` |
| `http2.constants.HTTP2_HEADER_FROM` | `'from'` |
| `http2.constants.HTTP2_HEADER_IF_MATCH` | `'if-match'` |
| `http2.constants.HTTP2_HEADER_IF_UNMODIFIED_SINCE` | `'if-unmodified-since'` |
| `http2.constants.HTTP2_HEADER_MAX_FORWARDS` | `'max-forwards'` |
| `http2.constants.HTTP2_HEADER_PREFER` | `'prefer'` |
| `http2.constants.HTTP2_HEADER_PROXY_AUTHENTICATE` | `'proxy-authenticate'` |
| `http2.constants.HTTP2_HEADER_PROXY_AUTHORIZATION` | `'proxy-authorization'` |
| `http2.constants.HTTP2_HEADER_REFRESH` | `'refresh'` |
| `http2.constants.HTTP2_HEADER_RETRY_AFTER` | `'retry-after'` |
| `http2.constants.HTTP2_HEADER_TRAILER` | `'trailer'` |
| `http2.constants.HTTP2_HEADER_TK` | `'tk'` |
| `http2.constants.HTTP2_HEADER_VIA` | `'via'` |
| `http2.constants.HTTP2_HEADER_WARNING` | `'warning'` |
| `http2.constants.HTTP2_HEADER_WWW_AUTHENTICATE` | `'www-authenticate'` |
| `http2.constants.HTTP2_HEADER_HTTP2_SETTINGS` | `'http2-settings'` |

#### Error codes for `RST_STREAM` and `GOAWAY`

| Value | Name | Constant |
Expand DownExpand Up@@ -3970,19 +4106,21 @@ API:
```mjs
import { createServer } from 'node:http2';
const server = createServer((req, res) => {
 res.setHeader('Content-Type', 'text/html');
 res.setHeader('X-Foo', 'bar');
 res.writeHead(200, { 'Content-Type': 'text/plain; charset=utf-8' });
 res.writeHead(200, {
 'Content-Type': 'text/plain; charset=utf-8',
 'X-Foo': 'bar',
 });
 res.end('ok');
});
```

```cjs
const http2 = require('node:http2');
const server = http2.createServer((req, res) => {
 res.setHeader('Content-Type', 'text/html');
 res.setHeader('X-Foo', 'bar');
 res.writeHead(200, { 'Content-Type': 'text/plain; charset=utf-8' });
 res.writeHead(200, {
 'Content-Type': 'text/plain; charset=utf-8',
 'X-Foo': 'bar',
 });
 res.end('ok');
});
```
Expand DownExpand Up@@ -5081,6 +5219,7 @@ you need to implement any fall-back behavior yourself.
[HTTP/2 Settings Object]: #settings-object
[HTTP/2 Unencrypted]: https://http2.github.io/faq/#does-http2-require-encryption
[HTTPS]: https.md
[Invalid character handling in header names and values]: #invalid-character-handling-in-header-names-and-values
[Performance Observer]: perf_hooks.md
[RFC 7838]: https://tools.ietf.org/html/rfc7838
[RFC 8336]: https://tools.ietf.org/html/rfc8336
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
doc: document http2 header constants#64548

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

 Merged

nodejs-github-bot
merged 1 commit into

from

Aug 14, 2026
 Merged


doc: document http2 header constants
#64548
 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


151 changes: 145 additions & 6 deletions
doc/api/http2.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3404,6 +3404,142 @@ client.close();
added: v8.4.0
-->

#### Header name constants

The `HTTP2_HEADER_*` constants provide names for HTTP/2 pseudo-headers and
known HTTP header names. Using these string constants is optional. For example,
`http2.constants.HTTP2_HEADER_CONTENT_TYPE` is equal to `'content-type'`.
For APIs that accept regular header names,
`http2.constants.HTTP2_HEADER_CONTENT_TYPE`, `'content-type'`, and
`'Content-Type'` have the same effect; Node.js serializes the name in
lower-case.

Regular header constants can be used with the compatibility API wherever the
corresponding literal header name is accepted. In compatibility API request
handlers, prefer `request.method`, `request.authority`, `request.scheme`, and
`request.url` for the corresponding pseudo-headers. Other incoming
pseudo-headers remain available through `request.headers`. Set response status
through `response.statusCode` or the `statusCode` argument to
`response.writeHead()`. Passing `HTTP2_HEADER_STATUS` (`':status'`) to
`response.setHeader()` or in `response.writeHead()`'s headers object throws
`ERR_HTTP2_PSEUDOHEADER_NOT_ALLOWED`. `HTTP2_HEADER_PROTOCOL` is a request
pseudo-header and cannot be sent in a response.

Incoming header object keys are lower-case, so use a constant or a lower-case
literal when accessing them as object properties. Using a constant does not
change header validation, and the availability of a constant does not imply
that the header is valid in every HTTP/2 context. See [HTTP/2 Headers Object][]
and [Invalid character handling in header names and values][] for details about
header casing and validation.

##### Pseudo-header constants

`HTTP2_HEADER_METHOD`, `HTTP2_HEADER_AUTHORITY`, `HTTP2_HEADER_SCHEME`, and
`HTTP2_HEADER_PATH` identify request pseudo-headers. `HTTP2_HEADER_STATUS`
identifies the response pseudo-header. `HTTP2_HEADER_PROTOCOL` identifies the
extended `CONNECT` request pseudo-header. Pseudo-headers are not permitted in
trailers.

| Constant | Value |
| ---------------------------------------- | -------------- |
| `http2.constants.HTTP2_HEADER_STATUS` | `':status'` |
| `http2.constants.HTTP2_HEADER_METHOD` | `':method'` |
| `http2.constants.HTTP2_HEADER_AUTHORITY` | `':authority'` |
| `http2.constants.HTTP2_HEADER_SCHEME` | `':scheme'` |
| `http2.constants.HTTP2_HEADER_PATH` | `':path'` |
| `http2.constants.HTTP2_HEADER_PROTOCOL` | `':protocol'` |

##### Regular header constants

The `HTTP2_HEADER_CONNECTION`, `HTTP2_HEADER_UPGRADE`,
`HTTP2_HEADER_HTTP2_SETTINGS`, `HTTP2_HEADER_KEEP_ALIVE`,
`HTTP2_HEADER_PROXY_CONNECTION`, and `HTTP2_HEADER_TRANSFER_ENCODING`
constants identify connection-specific headers that HTTP/2 does not permit.
`HTTP2_HEADER_TE` is permitted only when its value is `'trailers'`.

| Constant | Value |
| --------------------------------------------------------------- | ------------------------------------ |
| `http2.constants.HTTP2_HEADER_ACCEPT_ENCODING` | `'accept-encoding'` |
| `http2.constants.HTTP2_HEADER_ACCEPT_LANGUAGE` | `'accept-language'` |
| `http2.constants.HTTP2_HEADER_ACCEPT_RANGES` | `'accept-ranges'` |
| `http2.constants.HTTP2_HEADER_ACCEPT` | `'accept'` |
| `http2.constants.HTTP2_HEADER_ACCESS_CONTROL_ALLOW_CREDENTIALS` | `'access-control-allow-credentials'` |
| `http2.constants.HTTP2_HEADER_ACCESS_CONTROL_ALLOW_HEADERS` | `'access-control-allow-headers'` |
| `http2.constants.HTTP2_HEADER_ACCESS_CONTROL_ALLOW_METHODS` | `'access-control-allow-methods'` |
| `http2.constants.HTTP2_HEADER_ACCESS_CONTROL_ALLOW_ORIGIN` | `'access-control-allow-origin'` |
| `http2.constants.HTTP2_HEADER_ACCESS_CONTROL_EXPOSE_HEADERS` | `'access-control-expose-headers'` |
| `http2.constants.HTTP2_HEADER_ACCESS_CONTROL_REQUEST_HEADERS` | `'access-control-request-headers'` |
| `http2.constants.HTTP2_HEADER_ACCESS_CONTROL_REQUEST_METHOD` | `'access-control-request-method'` |
| `http2.constants.HTTP2_HEADER_AGE` | `'age'` |
| `http2.constants.HTTP2_HEADER_AUTHORIZATION` | `'authorization'` |
| `http2.constants.HTTP2_HEADER_CACHE_CONTROL` | `'cache-control'` |
| `http2.constants.HTTP2_HEADER_CONNECTION` | `'connection'` |
| `http2.constants.HTTP2_HEADER_CONTENT_DISPOSITION` | `'content-disposition'` |
| `http2.constants.HTTP2_HEADER_CONTENT_ENCODING` | `'content-encoding'` |
| `http2.constants.HTTP2_HEADER_CONTENT_LENGTH` | `'content-length'` |
| `http2.constants.HTTP2_HEADER_CONTENT_TYPE` | `'content-type'` |
| `http2.constants.HTTP2_HEADER_COOKIE` | `'cookie'` |
| `http2.constants.HTTP2_HEADER_DATE` | `'date'` |
| `http2.constants.HTTP2_HEADER_ETAG` | `'etag'` |
| `http2.constants.HTTP2_HEADER_FORWARDED` | `'forwarded'` |
| `http2.constants.HTTP2_HEADER_HOST` | `'host'` |
| `http2.constants.HTTP2_HEADER_IF_MODIFIED_SINCE` | `'if-modified-since'` |
| `http2.constants.HTTP2_HEADER_IF_NONE_MATCH` | `'if-none-match'` |
| `http2.constants.HTTP2_HEADER_IF_RANGE` | `'if-range'` |
| `http2.constants.HTTP2_HEADER_LAST_MODIFIED` | `'last-modified'` |
| `http2.constants.HTTP2_HEADER_LINK` | `'link'` |
| `http2.constants.HTTP2_HEADER_LOCATION` | `'location'` |
| `http2.constants.HTTP2_HEADER_RANGE` | `'range'` |
| `http2.constants.HTTP2_HEADER_REFERER` | `'referer'` |
| `http2.constants.HTTP2_HEADER_SERVER` | `'server'` |
| `http2.constants.HTTP2_HEADER_SET_COOKIE` | `'set-cookie'` |
| `http2.constants.HTTP2_HEADER_STRICT_TRANSPORT_SECURITY` | `'strict-transport-security'` |
| `http2.constants.HTTP2_HEADER_TRANSFER_ENCODING` | `'transfer-encoding'` |
| `http2.constants.HTTP2_HEADER_TE` | `'te'` |
| `http2.constants.HTTP2_HEADER_UPGRADE_INSECURE_REQUESTS` | `'upgrade-insecure-requests'` |
| `http2.constants.HTTP2_HEADER_UPGRADE` | `'upgrade'` |
| `http2.constants.HTTP2_HEADER_USER_AGENT` | `'user-agent'` |
| `http2.constants.HTTP2_HEADER_VARY` | `'vary'` |
| `http2.constants.HTTP2_HEADER_X_CONTENT_TYPE_OPTIONS` | `'x-content-type-options'` |
| `http2.constants.HTTP2_HEADER_X_FRAME_OPTIONS` | `'x-frame-options'` |
| `http2.constants.HTTP2_HEADER_KEEP_ALIVE` | `'keep-alive'` |
| `http2.constants.HTTP2_HEADER_PROXY_CONNECTION` | `'proxy-connection'` |
| `http2.constants.HTTP2_HEADER_X_XSS_PROTECTION` | `'x-xss-protection'` |
| `http2.constants.HTTP2_HEADER_ALT_SVC` | `'alt-svc'` |
| `http2.constants.HTTP2_HEADER_CONTENT_SECURITY_POLICY` | `'content-security-policy'` |
| `http2.constants.HTTP2_HEADER_EARLY_DATA` | `'early-data'` |
| `http2.constants.HTTP2_HEADER_EXPECT_CT` | `'expect-ct'` |
| `http2.constants.HTTP2_HEADER_ORIGIN` | `'origin'` |
| `http2.constants.HTTP2_HEADER_PURPOSE` | `'purpose'` |
| `http2.constants.HTTP2_HEADER_TIMING_ALLOW_ORIGIN` | `'timing-allow-origin'` |
| `http2.constants.HTTP2_HEADER_X_FORWARDED_FOR` | `'x-forwarded-for'` |
| `http2.constants.HTTP2_HEADER_PRIORITY` | `'priority'` |
| `http2.constants.HTTP2_HEADER_ACCEPT_CHARSET` | `'accept-charset'` |
| `http2.constants.HTTP2_HEADER_ACCESS_CONTROL_MAX_AGE` | `'access-control-max-age'` |
| `http2.constants.HTTP2_HEADER_ALLOW` | `'allow'` |
| `http2.constants.HTTP2_HEADER_CONTENT_LANGUAGE` | `'content-language'` |
| `http2.constants.HTTP2_HEADER_CONTENT_LOCATION` | `'content-location'` |
| `http2.constants.HTTP2_HEADER_CONTENT_MD5` | `'content-md5'` |
| `http2.constants.HTTP2_HEADER_CONTENT_RANGE` | `'content-range'` |
| `http2.constants.HTTP2_HEADER_DNT` | `'dnt'` |
| `http2.constants.HTTP2_HEADER_EXPECT` | `'expect'` |
| `http2.constants.HTTP2_HEADER_EXPIRES` | `'expires'` |
| `http2.constants.HTTP2_HEADER_FROM` | `'from'` |
| `http2.constants.HTTP2_HEADER_IF_MATCH` | `'if-match'` |
| `http2.constants.HTTP2_HEADER_IF_UNMODIFIED_SINCE` | `'if-unmodified-since'` |
| `http2.constants.HTTP2_HEADER_MAX_FORWARDS` | `'max-forwards'` |
| `http2.constants.HTTP2_HEADER_PREFER` | `'prefer'` |
| `http2.constants.HTTP2_HEADER_PROXY_AUTHENTICATE` | `'proxy-authenticate'` |
| `http2.constants.HTTP2_HEADER_PROXY_AUTHORIZATION` | `'proxy-authorization'` |
| `http2.constants.HTTP2_HEADER_REFRESH` | `'refresh'` |
| `http2.constants.HTTP2_HEADER_RETRY_AFTER` | `'retry-after'` |
| `http2.constants.HTTP2_HEADER_TRAILER` | `'trailer'` |
| `http2.constants.HTTP2_HEADER_TK` | `'tk'` |
| `http2.constants.HTTP2_HEADER_VIA` | `'via'` |
| `http2.constants.HTTP2_HEADER_WARNING` | `'warning'` |
| `http2.constants.HTTP2_HEADER_WWW_AUTHENTICATE` | `'www-authenticate'` |
| `http2.constants.HTTP2_HEADER_HTTP2_SETTINGS` | `'http2-settings'` |

#### Error codes for `RST_STREAM` and `GOAWAY`

| Value | Name | Constant |
Expand DownExpand Up@@ -3970,19 +4106,21 @@ API:
```mjs
import { createServer } from 'node:http2';
const server = createServer((req, res) => {
 res.setHeader('Content-Type', 'text/html');
 res.setHeader('X-Foo', 'bar');
 res.writeHead(200, { 'Content-Type': 'text/plain; charset=utf-8' });
 res.writeHead(200, {
 'Content-Type': 'text/plain; charset=utf-8',
 'X-Foo': 'bar',
 });
 res.end('ok');
});
```

```cjs
const http2 = require('node:http2');
const server = http2.createServer((req, res) => {
 res.setHeader('Content-Type', 'text/html');
 res.setHeader('X-Foo', 'bar');
 res.writeHead(200, { 'Content-Type': 'text/plain; charset=utf-8' });
 res.writeHead(200, {
 'Content-Type': 'text/plain; charset=utf-8',
 'X-Foo': 'bar',
 });
 res.end('ok');
});
```
Expand DownExpand Up@@ -5081,6 +5219,7 @@ you need to implement any fall-back behavior yourself.
[HTTP/2 Settings Object]: #settings-object
[HTTP/2 Unencrypted]: https://http2.github.io/faq/#does-http2-require-encryption
[HTTPS]: https.md
[Invalid character handling in header names and values]: #invalid-character-handling-in-header-names-and-values
[Performance Observer]: perf_hooks.md
[RFC 7838]: https://tools.ietf.org/html/rfc7838
[RFC 8336]: https://tools.ietf.org/html/rfc8336
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
doc: document http2 header constants#64548

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

 Merged

nodejs-github-bot
merged 1 commit into

from

Aug 14, 2026
 Merged


doc: document http2 header constants
#64548
 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


151 changes: 145 additions & 6 deletions
doc/api/http2.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3404,6 +3404,142 @@ client.close();
added: v8.4.0
-->

#### Header name constants

The `HTTP2_HEADER_*` constants provide names for HTTP/2 pseudo-headers and
known HTTP header names. Using these string constants is optional. For example,
`http2.constants.HTTP2_HEADER_CONTENT_TYPE` is equal to `'content-type'`.
For APIs that accept regular header names,
`http2.constants.HTTP2_HEADER_CONTENT_TYPE`, `'content-type'`, and
`'Content-Type'` have the same effect; Node.js serializes the name in
lower-case.

Regular header constants can be used with the compatibility API wherever the
corresponding literal header name is accepted. In compatibility API request
handlers, prefer `request.method`, `request.authority`, `request.scheme`, and
`request.url` for the corresponding pseudo-headers. Other incoming
pseudo-headers remain available through `request.headers`. Set response status
through `response.statusCode` or the `statusCode` argument to
`response.writeHead()`. Passing `HTTP2_HEADER_STATUS` (`':status'`) to
`response.setHeader()` or in `response.writeHead()`'s headers object throws
`ERR_HTTP2_PSEUDOHEADER_NOT_ALLOWED`. `HTTP2_HEADER_PROTOCOL` is a request
pseudo-header and cannot be sent in a response.

Incoming header object keys are lower-case, so use a constant or a lower-case
literal when accessing them as object properties. Using a constant does not
change header validation, and the availability of a constant does not imply
that the header is valid in every HTTP/2 context. See [HTTP/2 Headers Object][]
and [Invalid character handling in header names and values][] for details about
header casing and validation.

##### Pseudo-header constants

`HTTP2_HEADER_METHOD`, `HTTP2_HEADER_AUTHORITY`, `HTTP2_HEADER_SCHEME`, and
`HTTP2_HEADER_PATH` identify request pseudo-headers. `HTTP2_HEADER_STATUS`
identifies the response pseudo-header. `HTTP2_HEADER_PROTOCOL` identifies the
extended `CONNECT` request pseudo-header. Pseudo-headers are not permitted in
trailers.

| Constant | Value |
| ---------------------------------------- | -------------- |
| `http2.constants.HTTP2_HEADER_STATUS` | `':status'` |
| `http2.constants.HTTP2_HEADER_METHOD` | `':method'` |
| `http2.constants.HTTP2_HEADER_AUTHORITY` | `':authority'` |
| `http2.constants.HTTP2_HEADER_SCHEME` | `':scheme'` |
| `http2.constants.HTTP2_HEADER_PATH` | `':path'` |
| `http2.constants.HTTP2_HEADER_PROTOCOL` | `':protocol'` |

##### Regular header constants

The `HTTP2_HEADER_CONNECTION`, `HTTP2_HEADER_UPGRADE`,
`HTTP2_HEADER_HTTP2_SETTINGS`, `HTTP2_HEADER_KEEP_ALIVE`,
`HTTP2_HEADER_PROXY_CONNECTION`, and `HTTP2_HEADER_TRANSFER_ENCODING`
constants identify connection-specific headers that HTTP/2 does not permit.
`HTTP2_HEADER_TE` is permitted only when its value is `'trailers'`.

| Constant | Value |
| --------------------------------------------------------------- | ------------------------------------ |
| `http2.constants.HTTP2_HEADER_ACCEPT_ENCODING` | `'accept-encoding'` |
| `http2.constants.HTTP2_HEADER_ACCEPT_LANGUAGE` | `'accept-language'` |
| `http2.constants.HTTP2_HEADER_ACCEPT_RANGES` | `'accept-ranges'` |
| `http2.constants.HTTP2_HEADER_ACCEPT` | `'accept'` |
| `http2.constants.HTTP2_HEADER_ACCESS_CONTROL_ALLOW_CREDENTIALS` | `'access-control-allow-credentials'` |
| `http2.constants.HTTP2_HEADER_ACCESS_CONTROL_ALLOW_HEADERS` | `'access-control-allow-headers'` |
| `http2.constants.HTTP2_HEADER_ACCESS_CONTROL_ALLOW_METHODS` | `'access-control-allow-methods'` |
| `http2.constants.HTTP2_HEADER_ACCESS_CONTROL_ALLOW_ORIGIN` | `'access-control-allow-origin'` |
| `http2.constants.HTTP2_HEADER_ACCESS_CONTROL_EXPOSE_HEADERS` | `'access-control-expose-headers'` |
| `http2.constants.HTTP2_HEADER_ACCESS_CONTROL_REQUEST_HEADERS` | `'access-control-request-headers'` |
| `http2.constants.HTTP2_HEADER_ACCESS_CONTROL_REQUEST_METHOD` | `'access-control-request-method'` |
| `http2.constants.HTTP2_HEADER_AGE` | `'age'` |
| `http2.constants.HTTP2_HEADER_AUTHORIZATION` | `'authorization'` |
| `http2.constants.HTTP2_HEADER_CACHE_CONTROL` | `'cache-control'` |
| `http2.constants.HTTP2_HEADER_CONNECTION` | `'connection'` |
| `http2.constants.HTTP2_HEADER_CONTENT_DISPOSITION` | `'content-disposition'` |
| `http2.constants.HTTP2_HEADER_CONTENT_ENCODING` | `'content-encoding'` |
| `http2.constants.HTTP2_HEADER_CONTENT_LENGTH` | `'content-length'` |
| `http2.constants.HTTP2_HEADER_CONTENT_TYPE` | `'content-type'` |
| `http2.constants.HTTP2_HEADER_COOKIE` | `'cookie'` |
| `http2.constants.HTTP2_HEADER_DATE` | `'date'` |
| `http2.constants.HTTP2_HEADER_ETAG` | `'etag'` |
| `http2.constants.HTTP2_HEADER_FORWARDED` | `'forwarded'` |
| `http2.constants.HTTP2_HEADER_HOST` | `'host'` |
| `http2.constants.HTTP2_HEADER_IF_MODIFIED_SINCE` | `'if-modified-since'` |
| `http2.constants.HTTP2_HEADER_IF_NONE_MATCH` | `'if-none-match'` |
| `http2.constants.HTTP2_HEADER_IF_RANGE` | `'if-range'` |
| `http2.constants.HTTP2_HEADER_LAST_MODIFIED` | `'last-modified'` |
| `http2.constants.HTTP2_HEADER_LINK` | `'link'` |
| `http2.constants.HTTP2_HEADER_LOCATION` | `'location'` |
| `http2.constants.HTTP2_HEADER_RANGE` | `'range'` |
| `http2.constants.HTTP2_HEADER_REFERER` | `'referer'` |
| `http2.constants.HTTP2_HEADER_SERVER` | `'server'` |
| `http2.constants.HTTP2_HEADER_SET_COOKIE` | `'set-cookie'` |
| `http2.constants.HTTP2_HEADER_STRICT_TRANSPORT_SECURITY` | `'strict-transport-security'` |
| `http2.constants.HTTP2_HEADER_TRANSFER_ENCODING` | `'transfer-encoding'` |
| `http2.constants.HTTP2_HEADER_TE` | `'te'` |
| `http2.constants.HTTP2_HEADER_UPGRADE_INSECURE_REQUESTS` | `'upgrade-insecure-requests'` |
| `http2.constants.HTTP2_HEADER_UPGRADE` | `'upgrade'` |
| `http2.constants.HTTP2_HEADER_USER_AGENT` | `'user-agent'` |
| `http2.constants.HTTP2_HEADER_VARY` | `'vary'` |
| `http2.constants.HTTP2_HEADER_X_CONTENT_TYPE_OPTIONS` | `'x-content-type-options'` |
| `http2.constants.HTTP2_HEADER_X_FRAME_OPTIONS` | `'x-frame-options'` |
| `http2.constants.HTTP2_HEADER_KEEP_ALIVE` | `'keep-alive'` |
| `http2.constants.HTTP2_HEADER_PROXY_CONNECTION` | `'proxy-connection'` |
| `http2.constants.HTTP2_HEADER_X_XSS_PROTECTION` | `'x-xss-protection'` |
| `http2.constants.HTTP2_HEADER_ALT_SVC` | `'alt-svc'` |
| `http2.constants.HTTP2_HEADER_CONTENT_SECURITY_POLICY` | `'content-security-policy'` |
| `http2.constants.HTTP2_HEADER_EARLY_DATA` | `'early-data'` |
| `http2.constants.HTTP2_HEADER_EXPECT_CT` | `'expect-ct'` |
| `http2.constants.HTTP2_HEADER_ORIGIN` | `'origin'` |
| `http2.constants.HTTP2_HEADER_PURPOSE` | `'purpose'` |
| `http2.constants.HTTP2_HEADER_TIMING_ALLOW_ORIGIN` | `'timing-allow-origin'` |
| `http2.constants.HTTP2_HEADER_X_FORWARDED_FOR` | `'x-forwarded-for'` |
| `http2.constants.HTTP2_HEADER_PRIORITY` | `'priority'` |
| `http2.constants.HTTP2_HEADER_ACCEPT_CHARSET` | `'accept-charset'` |
| `http2.constants.HTTP2_HEADER_ACCESS_CONTROL_MAX_AGE` | `'access-control-max-age'` |
| `http2.constants.HTTP2_HEADER_ALLOW` | `'allow'` |
| `http2.constants.HTTP2_HEADER_CONTENT_LANGUAGE` | `'content-language'` |
| `http2.constants.HTTP2_HEADER_CONTENT_LOCATION` | `'content-location'` |
| `http2.constants.HTTP2_HEADER_CONTENT_MD5` | `'content-md5'` |
| `http2.constants.HTTP2_HEADER_CONTENT_RANGE` | `'content-range'` |
| `http2.constants.HTTP2_HEADER_DNT` | `'dnt'` |
| `http2.constants.HTTP2_HEADER_EXPECT` | `'expect'` |
| `http2.constants.HTTP2_HEADER_EXPIRES` | `'expires'` |
| `http2.constants.HTTP2_HEADER_FROM` | `'from'` |
| `http2.constants.HTTP2_HEADER_IF_MATCH` | `'if-match'` |
| `http2.constants.HTTP2_HEADER_IF_UNMODIFIED_SINCE` | `'if-unmodified-since'` |
| `http2.constants.HTTP2_HEADER_MAX_FORWARDS` | `'max-forwards'` |
| `http2.constants.HTTP2_HEADER_PREFER` | `'prefer'` |
| `http2.constants.HTTP2_HEADER_PROXY_AUTHENTICATE` | `'proxy-authenticate'` |
| `http2.constants.HTTP2_HEADER_PROXY_AUTHORIZATION` | `'proxy-authorization'` |
| `http2.constants.HTTP2_HEADER_REFRESH` | `'refresh'` |
| `http2.constants.HTTP2_HEADER_RETRY_AFTER` | `'retry-after'` |
| `http2.constants.HTTP2_HEADER_TRAILER` | `'trailer'` |
| `http2.constants.HTTP2_HEADER_TK` | `'tk'` |
| `http2.constants.HTTP2_HEADER_VIA` | `'via'` |
| `http2.constants.HTTP2_HEADER_WARNING` | `'warning'` |
| `http2.constants.HTTP2_HEADER_WWW_AUTHENTICATE` | `'www-authenticate'` |
| `http2.constants.HTTP2_HEADER_HTTP2_SETTINGS` | `'http2-settings'` |

#### Error codes for `RST_STREAM` and `GOAWAY`

| Value | Name | Constant |
Expand DownExpand Up@@ -3970,19 +4106,21 @@ API:
```mjs
import { createServer } from 'node:http2';
const server = createServer((req, res) => {
 res.setHeader('Content-Type', 'text/html');
 res.setHeader('X-Foo', 'bar');
 res.writeHead(200, { 'Content-Type': 'text/plain; charset=utf-8' });
 res.writeHead(200, {
 'Content-Type': 'text/plain; charset=utf-8',
 'X-Foo': 'bar',
 });
 res.end('ok');
});
```

```cjs
const http2 = require('node:http2');
const server = http2.createServer((req, res) => {
 res.setHeader('Content-Type', 'text/html');
 res.setHeader('X-Foo', 'bar');
 res.writeHead(200, { 'Content-Type': 'text/plain; charset=utf-8' });
 res.writeHead(200, {
 'Content-Type': 'text/plain; charset=utf-8',
 'X-Foo': 'bar',
 });
 res.end('ok');
});
```
Expand DownExpand Up@@ -5081,6 +5219,7 @@ you need to implement any fall-back behavior yourself.
[HTTP/2 Settings Object]: #settings-object
[HTTP/2 Unencrypted]: https://http2.github.io/faq/#does-http2-require-encryption
[HTTPS]: https.md
[Invalid character handling in header names and values]: #invalid-character-handling-in-header-names-and-values
[Performance Observer]: perf_hooks.md
[RFC 7838]: https://tools.ietf.org/html/rfc7838
[RFC 8336]: https://tools.ietf.org/html/rfc8336
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
doc: document http2 header constants#64548

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

 Merged

nodejs-github-bot
merged 1 commit into

from

Aug 14, 2026
 Merged


doc: document http2 header constants
#64548
 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


151 changes: 145 additions & 6 deletions
doc/api/http2.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3404,6 +3404,142 @@ client.close();
added: v8.4.0
-->

#### Header name constants

The `HTTP2_HEADER_*` constants provide names for HTTP/2 pseudo-headers and
known HTTP header names. Using these string constants is optional. For example,
`http2.constants.HTTP2_HEADER_CONTENT_TYPE` is equal to `'content-type'`.
For APIs that accept regular header names,
`http2.constants.HTTP2_HEADER_CONTENT_TYPE`, `'content-type'`, and
`'Content-Type'` have the same effect; Node.js serializes the name in
lower-case.

Regular header constants can be used with the compatibility API wherever the
corresponding literal header name is accepted. In compatibility API request
handlers, prefer `request.method`, `request.authority`, `request.scheme`, and
`request.url` for the corresponding pseudo-headers. Other incoming
pseudo-headers remain available through `request.headers`. Set response status
through `response.statusCode` or the `statusCode` argument to
`response.writeHead()`. Passing `HTTP2_HEADER_STATUS` (`':status'`) to
`response.setHeader()` or in `response.writeHead()`'s headers object throws
`ERR_HTTP2_PSEUDOHEADER_NOT_ALLOWED`. `HTTP2_HEADER_PROTOCOL` is a request
pseudo-header and cannot be sent in a response.

Incoming header object keys are lower-case, so use a constant or a lower-case
literal when accessing them as object properties. Using a constant does not
change header validation, and the availability of a constant does not imply
that the header is valid in every HTTP/2 context. See [HTTP/2 Headers Object][]
and [Invalid character handling in header names and values][] for details about
header casing and validation.

##### Pseudo-header constants

`HTTP2_HEADER_METHOD`, `HTTP2_HEADER_AUTHORITY`, `HTTP2_HEADER_SCHEME`, and
`HTTP2_HEADER_PATH` identify request pseudo-headers. `HTTP2_HEADER_STATUS`
identifies the response pseudo-header. `HTTP2_HEADER_PROTOCOL` identifies the
extended `CONNECT` request pseudo-header. Pseudo-headers are not permitted in
trailers.

| Constant | Value |
| ---------------------------------------- | -------------- |
| `http2.constants.HTTP2_HEADER_STATUS` | `':status'` |
| `http2.constants.HTTP2_HEADER_METHOD` | `':method'` |
| `http2.constants.HTTP2_HEADER_AUTHORITY` | `':authority'` |
| `http2.constants.HTTP2_HEADER_SCHEME` | `':scheme'` |
| `http2.constants.HTTP2_HEADER_PATH` | `':path'` |
| `http2.constants.HTTP2_HEADER_PROTOCOL` | `':protocol'` |

##### Regular header constants

The `HTTP2_HEADER_CONNECTION`, `HTTP2_HEADER_UPGRADE`,
`HTTP2_HEADER_HTTP2_SETTINGS`, `HTTP2_HEADER_KEEP_ALIVE`,
`HTTP2_HEADER_PROXY_CONNECTION`, and `HTTP2_HEADER_TRANSFER_ENCODING`
constants identify connection-specific headers that HTTP/2 does not permit.
`HTTP2_HEADER_TE` is permitted only when its value is `'trailers'`.

| Constant | Value |
| --------------------------------------------------------------- | ------------------------------------ |
| `http2.constants.HTTP2_HEADER_ACCEPT_ENCODING` | `'accept-encoding'` |
| `http2.constants.HTTP2_HEADER_ACCEPT_LANGUAGE` | `'accept-language'` |
| `http2.constants.HTTP2_HEADER_ACCEPT_RANGES` | `'accept-ranges'` |
| `http2.constants.HTTP2_HEADER_ACCEPT` | `'accept'` |
| `http2.constants.HTTP2_HEADER_ACCESS_CONTROL_ALLOW_CREDENTIALS` | `'access-control-allow-credentials'` |
| `http2.constants.HTTP2_HEADER_ACCESS_CONTROL_ALLOW_HEADERS` | `'access-control-allow-headers'` |
| `http2.constants.HTTP2_HEADER_ACCESS_CONTROL_ALLOW_METHODS` | `'access-control-allow-methods'` |
| `http2.constants.HTTP2_HEADER_ACCESS_CONTROL_ALLOW_ORIGIN` | `'access-control-allow-origin'` |
| `http2.constants.HTTP2_HEADER_ACCESS_CONTROL_EXPOSE_HEADERS` | `'access-control-expose-headers'` |
| `http2.constants.HTTP2_HEADER_ACCESS_CONTROL_REQUEST_HEADERS` | `'access-control-request-headers'` |
| `http2.constants.HTTP2_HEADER_ACCESS_CONTROL_REQUEST_METHOD` | `'access-control-request-method'` |
| `http2.constants.HTTP2_HEADER_AGE` | `'age'` |
| `http2.constants.HTTP2_HEADER_AUTHORIZATION` | `'authorization'` |
| `http2.constants.HTTP2_HEADER_CACHE_CONTROL` | `'cache-control'` |
| `http2.constants.HTTP2_HEADER_CONNECTION` | `'connection'` |
| `http2.constants.HTTP2_HEADER_CONTENT_DISPOSITION` | `'content-disposition'` |
| `http2.constants.HTTP2_HEADER_CONTENT_ENCODING` | `'content-encoding'` |
| `http2.constants.HTTP2_HEADER_CONTENT_LENGTH` | `'content-length'` |
| `http2.constants.HTTP2_HEADER_CONTENT_TYPE` | `'content-type'` |
| `http2.constants.HTTP2_HEADER_COOKIE` | `'cookie'` |
| `http2.constants.HTTP2_HEADER_DATE` | `'date'` |
| `http2.constants.HTTP2_HEADER_ETAG` | `'etag'` |
| `http2.constants.HTTP2_HEADER_FORWARDED` | `'forwarded'` |
| `http2.constants.HTTP2_HEADER_HOST` | `'host'` |
| `http2.constants.HTTP2_HEADER_IF_MODIFIED_SINCE` | `'if-modified-since'` |
| `http2.constants.HTTP2_HEADER_IF_NONE_MATCH` | `'if-none-match'` |
| `http2.constants.HTTP2_HEADER_IF_RANGE` | `'if-range'` |
| `http2.constants.HTTP2_HEADER_LAST_MODIFIED` | `'last-modified'` |
| `http2.constants.HTTP2_HEADER_LINK` | `'link'` |
| `http2.constants.HTTP2_HEADER_LOCATION` | `'location'` |
| `http2.constants.HTTP2_HEADER_RANGE` | `'range'` |
| `http2.constants.HTTP2_HEADER_REFERER` | `'referer'` |
| `http2.constants.HTTP2_HEADER_SERVER` | `'server'` |
| `http2.constants.HTTP2_HEADER_SET_COOKIE` | `'set-cookie'` |
| `http2.constants.HTTP2_HEADER_STRICT_TRANSPORT_SECURITY` | `'strict-transport-security'` |
| `http2.constants.HTTP2_HEADER_TRANSFER_ENCODING` | `'transfer-encoding'` |
| `http2.constants.HTTP2_HEADER_TE` | `'te'` |
| `http2.constants.HTTP2_HEADER_UPGRADE_INSECURE_REQUESTS` | `'upgrade-insecure-requests'` |
| `http2.constants.HTTP2_HEADER_UPGRADE` | `'upgrade'` |
| `http2.constants.HTTP2_HEADER_USER_AGENT` | `'user-agent'` |
| `http2.constants.HTTP2_HEADER_VARY` | `'vary'` |
| `http2.constants.HTTP2_HEADER_X_CONTENT_TYPE_OPTIONS` | `'x-content-type-options'` |
| `http2.constants.HTTP2_HEADER_X_FRAME_OPTIONS` | `'x-frame-options'` |
| `http2.constants.HTTP2_HEADER_KEEP_ALIVE` | `'keep-alive'` |
| `http2.constants.HTTP2_HEADER_PROXY_CONNECTION` | `'proxy-connection'` |
| `http2.constants.HTTP2_HEADER_X_XSS_PROTECTION` | `'x-xss-protection'` |
| `http2.constants.HTTP2_HEADER_ALT_SVC` | `'alt-svc'` |
| `http2.constants.HTTP2_HEADER_CONTENT_SECURITY_POLICY` | `'content-security-policy'` |
| `http2.constants.HTTP2_HEADER_EARLY_DATA` | `'early-data'` |
| `http2.constants.HTTP2_HEADER_EXPECT_CT` | `'expect-ct'` |
| `http2.constants.HTTP2_HEADER_ORIGIN` | `'origin'` |
| `http2.constants.HTTP2_HEADER_PURPOSE` | `'purpose'` |
| `http2.constants.HTTP2_HEADER_TIMING_ALLOW_ORIGIN` | `'timing-allow-origin'` |
| `http2.constants.HTTP2_HEADER_X_FORWARDED_FOR` | `'x-forwarded-for'` |
| `http2.constants.HTTP2_HEADER_PRIORITY` | `'priority'` |
| `http2.constants.HTTP2_HEADER_ACCEPT_CHARSET` | `'accept-charset'` |
| `http2.constants.HTTP2_HEADER_ACCESS_CONTROL_MAX_AGE` | `'access-control-max-age'` |
| `http2.constants.HTTP2_HEADER_ALLOW` | `'allow'` |
| `http2.constants.HTTP2_HEADER_CONTENT_LANGUAGE` | `'content-language'` |
| `http2.constants.HTTP2_HEADER_CONTENT_LOCATION` | `'content-location'` |
| `http2.constants.HTTP2_HEADER_CONTENT_MD5` | `'content-md5'` |
| `http2.constants.HTTP2_HEADER_CONTENT_RANGE` | `'content-range'` |
| `http2.constants.HTTP2_HEADER_DNT` | `'dnt'` |
| `http2.constants.HTTP2_HEADER_EXPECT` | `'expect'` |
| `http2.constants.HTTP2_HEADER_EXPIRES` | `'expires'` |
| `http2.constants.HTTP2_HEADER_FROM` | `'from'` |
| `http2.constants.HTTP2_HEADER_IF_MATCH` | `'if-match'` |
| `http2.constants.HTTP2_HEADER_IF_UNMODIFIED_SINCE` | `'if-unmodified-since'` |
| `http2.constants.HTTP2_HEADER_MAX_FORWARDS` | `'max-forwards'` |
| `http2.constants.HTTP2_HEADER_PREFER` | `'prefer'` |
| `http2.constants.HTTP2_HEADER_PROXY_AUTHENTICATE` | `'proxy-authenticate'` |
| `http2.constants.HTTP2_HEADER_PROXY_AUTHORIZATION` | `'proxy-authorization'` |
| `http2.constants.HTTP2_HEADER_REFRESH` | `'refresh'` |
| `http2.constants.HTTP2_HEADER_RETRY_AFTER` | `'retry-after'` |
| `http2.constants.HTTP2_HEADER_TRAILER` | `'trailer'` |
| `http2.constants.HTTP2_HEADER_TK` | `'tk'` |
| `http2.constants.HTTP2_HEADER_VIA` | `'via'` |
| `http2.constants.HTTP2_HEADER_WARNING` | `'warning'` |
| `http2.constants.HTTP2_HEADER_WWW_AUTHENTICATE` | `'www-authenticate'` |
| `http2.constants.HTTP2_HEADER_HTTP2_SETTINGS` | `'http2-settings'` |

#### Error codes for `RST_STREAM` and `GOAWAY`

| Value | Name | Constant |
Expand DownExpand Up@@ -3970,19 +4106,21 @@ API:
```mjs
import { createServer } from 'node:http2';
const server = createServer((req, res) => {
 res.setHeader('Content-Type', 'text/html');
 res.setHeader('X-Foo', 'bar');
 res.writeHead(200, { 'Content-Type': 'text/plain; charset=utf-8' });
 res.writeHead(200, {
 'Content-Type': 'text/plain; charset=utf-8',
 'X-Foo': 'bar',
 });
 res.end('ok');
});
```

```cjs
const http2 = require('node:http2');
const server = http2.createServer((req, res) => {
 res.setHeader('Content-Type', 'text/html');
 res.setHeader('X-Foo', 'bar');
 res.writeHead(200, { 'Content-Type': 'text/plain; charset=utf-8' });
 res.writeHead(200, {
 'Content-Type': 'text/plain; charset=utf-8',
 'X-Foo': 'bar',
 });
 res.end('ok');
});
```
Expand DownExpand Up@@ -5081,6 +5219,7 @@ you need to implement any fall-back behavior yourself.
[HTTP/2 Settings Object]: #settings-object
[HTTP/2 Unencrypted]: https://http2.github.io/faq/#does-http2-require-encryption
[HTTPS]: https.md
[Invalid character handling in header names and values]: #invalid-character-handling-in-header-names-and-values
[Performance Observer]: perf_hooks.md
[RFC 7838]: https://tools.ietf.org/html/rfc7838
[RFC 8336]: https://tools.ietf.org/html/rfc8336
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
doc: document http2 header constants#64548

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

 Merged

nodejs-github-bot
merged 1 commit into

from

Aug 14, 2026
 Merged


doc: document http2 header constants
#64548
 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


151 changes: 145 additions & 6 deletions
doc/api/http2.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3404,6 +3404,142 @@ client.close();
added: v8.4.0
-->

#### Header name constants

The `HTTP2_HEADER_*` constants provide names for HTTP/2 pseudo-headers and
known HTTP header names. Using these string constants is optional. For example,
`http2.constants.HTTP2_HEADER_CONTENT_TYPE` is equal to `'content-type'`.
For APIs that accept regular header names,
`http2.constants.HTTP2_HEADER_CONTENT_TYPE`, `'content-type'`, and
`'Content-Type'` have the same effect; Node.js serializes the name in
lower-case.

Regular header constants can be used with the compatibility API wherever the
corresponding literal header name is accepted. In compatibility API request
handlers, prefer `request.method`, `request.authority`, `request.scheme`, and
`request.url` for the corresponding pseudo-headers. Other incoming
pseudo-headers remain available through `request.headers`. Set response status
through `response.statusCode` or the `statusCode` argument to
`response.writeHead()`. Passing `HTTP2_HEADER_STATUS` (`':status'`) to
`response.setHeader()` or in `response.writeHead()`'s headers object throws
`ERR_HTTP2_PSEUDOHEADER_NOT_ALLOWED`. `HTTP2_HEADER_PROTOCOL` is a request
pseudo-header and cannot be sent in a response.

Incoming header object keys are lower-case, so use a constant or a lower-case
literal when accessing them as object properties. Using a constant does not
change header validation, and the availability of a constant does not imply
that the header is valid in every HTTP/2 context. See [HTTP/2 Headers Object][]
and [Invalid character handling in header names and values][] for details about
header casing and validation.

##### Pseudo-header constants

`HTTP2_HEADER_METHOD`, `HTTP2_HEADER_AUTHORITY`, `HTTP2_HEADER_SCHEME`, and
`HTTP2_HEADER_PATH` identify request pseudo-headers. `HTTP2_HEADER_STATUS`
identifies the response pseudo-header. `HTTP2_HEADER_PROTOCOL` identifies the
extended `CONNECT` request pseudo-header. Pseudo-headers are not permitted in
trailers.

| Constant | Value |
| ---------------------------------------- | -------------- |
| `http2.constants.HTTP2_HEADER_STATUS` | `':status'` |
| `http2.constants.HTTP2_HEADER_METHOD` | `':method'` |
| `http2.constants.HTTP2_HEADER_AUTHORITY` | `':authority'` |
| `http2.constants.HTTP2_HEADER_SCHEME` | `':scheme'` |
| `http2.constants.HTTP2_HEADER_PATH` | `':path'` |
| `http2.constants.HTTP2_HEADER_PROTOCOL` | `':protocol'` |

##### Regular header constants

The `HTTP2_HEADER_CONNECTION`, `HTTP2_HEADER_UPGRADE`,
`HTTP2_HEADER_HTTP2_SETTINGS`, `HTTP2_HEADER_KEEP_ALIVE`,
`HTTP2_HEADER_PROXY_CONNECTION`, and `HTTP2_HEADER_TRANSFER_ENCODING`
constants identify connection-specific headers that HTTP/2 does not permit.
`HTTP2_HEADER_TE` is permitted only when its value is `'trailers'`.

| Constant | Value |
| --------------------------------------------------------------- | ------------------------------------ |
| `http2.constants.HTTP2_HEADER_ACCEPT_ENCODING` | `'accept-encoding'` |
| `http2.constants.HTTP2_HEADER_ACCEPT_LANGUAGE` | `'accept-language'` |
| `http2.constants.HTTP2_HEADER_ACCEPT_RANGES` | `'accept-ranges'` |
| `http2.constants.HTTP2_HEADER_ACCEPT` | `'accept'` |
| `http2.constants.HTTP2_HEADER_ACCESS_CONTROL_ALLOW_CREDENTIALS` | `'access-control-allow-credentials'` |
| `http2.constants.HTTP2_HEADER_ACCESS_CONTROL_ALLOW_HEADERS` | `'access-control-allow-headers'` |
| `http2.constants.HTTP2_HEADER_ACCESS_CONTROL_ALLOW_METHODS` | `'access-control-allow-methods'` |
| `http2.constants.HTTP2_HEADER_ACCESS_CONTROL_ALLOW_ORIGIN` | `'access-control-allow-origin'` |
| `http2.constants.HTTP2_HEADER_ACCESS_CONTROL_EXPOSE_HEADERS` | `'access-control-expose-headers'` |
| `http2.constants.HTTP2_HEADER_ACCESS_CONTROL_REQUEST_HEADERS` | `'access-control-request-headers'` |
| `http2.constants.HTTP2_HEADER_ACCESS_CONTROL_REQUEST_METHOD` | `'access-control-request-method'` |
| `http2.constants.HTTP2_HEADER_AGE` | `'age'` |
| `http2.constants.HTTP2_HEADER_AUTHORIZATION` | `'authorization'` |
| `http2.constants.HTTP2_HEADER_CACHE_CONTROL` | `'cache-control'` |
| `http2.constants.HTTP2_HEADER_CONNECTION` | `'connection'` |
| `http2.constants.HTTP2_HEADER_CONTENT_DISPOSITION` | `'content-disposition'` |
| `http2.constants.HTTP2_HEADER_CONTENT_ENCODING` | `'content-encoding'` |
| `http2.constants.HTTP2_HEADER_CONTENT_LENGTH` | `'content-length'` |
| `http2.constants.HTTP2_HEADER_CONTENT_TYPE` | `'content-type'` |
| `http2.constants.HTTP2_HEADER_COOKIE` | `'cookie'` |
| `http2.constants.HTTP2_HEADER_DATE` | `'date'` |
| `http2.constants.HTTP2_HEADER_ETAG` | `'etag'` |
| `http2.constants.HTTP2_HEADER_FORWARDED` | `'forwarded'` |
| `http2.constants.HTTP2_HEADER_HOST` | `'host'` |
| `http2.constants.HTTP2_HEADER_IF_MODIFIED_SINCE` | `'if-modified-since'` |
| `http2.constants.HTTP2_HEADER_IF_NONE_MATCH` | `'if-none-match'` |
| `http2.constants.HTTP2_HEADER_IF_RANGE` | `'if-range'` |
| `http2.constants.HTTP2_HEADER_LAST_MODIFIED` | `'last-modified'` |
| `http2.constants.HTTP2_HEADER_LINK` | `'link'` |
| `http2.constants.HTTP2_HEADER_LOCATION` | `'location'` |
| `http2.constants.HTTP2_HEADER_RANGE` | `'range'` |
| `http2.constants.HTTP2_HEADER_REFERER` | `'referer'` |
| `http2.constants.HTTP2_HEADER_SERVER` | `'server'` |
| `http2.constants.HTTP2_HEADER_SET_COOKIE` | `'set-cookie'` |
| `http2.constants.HTTP2_HEADER_STRICT_TRANSPORT_SECURITY` | `'strict-transport-security'` |
| `http2.constants.HTTP2_HEADER_TRANSFER_ENCODING` | `'transfer-encoding'` |
| `http2.constants.HTTP2_HEADER_TE` | `'te'` |
| `http2.constants.HTTP2_HEADER_UPGRADE_INSECURE_REQUESTS` | `'upgrade-insecure-requests'` |
| `http2.constants.HTTP2_HEADER_UPGRADE` | `'upgrade'` |
| `http2.constants.HTTP2_HEADER_USER_AGENT` | `'user-agent'` |
| `http2.constants.HTTP2_HEADER_VARY` | `'vary'` |
| `http2.constants.HTTP2_HEADER_X_CONTENT_TYPE_OPTIONS` | `'x-content-type-options'` |
| `http2.constants.HTTP2_HEADER_X_FRAME_OPTIONS` | `'x-frame-options'` |
| `http2.constants.HTTP2_HEADER_KEEP_ALIVE` | `'keep-alive'` |
| `http2.constants.HTTP2_HEADER_PROXY_CONNECTION` | `'proxy-connection'` |
| `http2.constants.HTTP2_HEADER_X_XSS_PROTECTION` | `'x-xss-protection'` |
| `http2.constants.HTTP2_HEADER_ALT_SVC` | `'alt-svc'` |
| `http2.constants.HTTP2_HEADER_CONTENT_SECURITY_POLICY` | `'content-security-policy'` |
| `http2.constants.HTTP2_HEADER_EARLY_DATA` | `'early-data'` |
| `http2.constants.HTTP2_HEADER_EXPECT_CT` | `'expect-ct'` |
| `http2.constants.HTTP2_HEADER_ORIGIN` | `'origin'` |
| `http2.constants.HTTP2_HEADER_PURPOSE` | `'purpose'` |
| `http2.constants.HTTP2_HEADER_TIMING_ALLOW_ORIGIN` | `'timing-allow-origin'` |
| `http2.constants.HTTP2_HEADER_X_FORWARDED_FOR` | `'x-forwarded-for'` |
| `http2.constants.HTTP2_HEADER_PRIORITY` | `'priority'` |
| `http2.constants.HTTP2_HEADER_ACCEPT_CHARSET` | `'accept-charset'` |
| `http2.constants.HTTP2_HEADER_ACCESS_CONTROL_MAX_AGE` | `'access-control-max-age'` |
| `http2.constants.HTTP2_HEADER_ALLOW` | `'allow'` |
| `http2.constants.HTTP2_HEADER_CONTENT_LANGUAGE` | `'content-language'` |
| `http2.constants.HTTP2_HEADER_CONTENT_LOCATION` | `'content-location'` |
| `http2.constants.HTTP2_HEADER_CONTENT_MD5` | `'content-md5'` |
| `http2.constants.HTTP2_HEADER_CONTENT_RANGE` | `'content-range'` |
| `http2.constants.HTTP2_HEADER_DNT` | `'dnt'` |
| `http2.constants.HTTP2_HEADER_EXPECT` | `'expect'` |
| `http2.constants.HTTP2_HEADER_EXPIRES` | `'expires'` |
| `http2.constants.HTTP2_HEADER_FROM` | `'from'` |
| `http2.constants.HTTP2_HEADER_IF_MATCH` | `'if-match'` |
| `http2.constants.HTTP2_HEADER_IF_UNMODIFIED_SINCE` | `'if-unmodified-since'` |
| `http2.constants.HTTP2_HEADER_MAX_FORWARDS` | `'max-forwards'` |
| `http2.constants.HTTP2_HEADER_PREFER` | `'prefer'` |
| `http2.constants.HTTP2_HEADER_PROXY_AUTHENTICATE` | `'proxy-authenticate'` |
| `http2.constants.HTTP2_HEADER_PROXY_AUTHORIZATION` | `'proxy-authorization'` |
| `http2.constants.HTTP2_HEADER_REFRESH` | `'refresh'` |
| `http2.constants.HTTP2_HEADER_RETRY_AFTER` | `'retry-after'` |
| `http2.constants.HTTP2_HEADER_TRAILER` | `'trailer'` |
| `http2.constants.HTTP2_HEADER_TK` | `'tk'` |
| `http2.constants.HTTP2_HEADER_VIA` | `'via'` |
| `http2.constants.HTTP2_HEADER_WARNING` | `'warning'` |
| `http2.constants.HTTP2_HEADER_WWW_AUTHENTICATE` | `'www-authenticate'` |
| `http2.constants.HTTP2_HEADER_HTTP2_SETTINGS` | `'http2-settings'` |

#### Error codes for `RST_STREAM` and `GOAWAY`

| Value | Name | Constant |
Expand DownExpand Up@@ -3970,19 +4106,21 @@ API:
```mjs
import { createServer } from 'node:http2';
const server = createServer((req, res) => {
 res.setHeader('Content-Type', 'text/html');
 res.setHeader('X-Foo', 'bar');
 res.writeHead(200, { 'Content-Type': 'text/plain; charset=utf-8' });
 res.writeHead(200, {
 'Content-Type': 'text/plain; charset=utf-8',
 'X-Foo': 'bar',
 });
 res.end('ok');
});
```

```cjs
const http2 = require('node:http2');
const server = http2.createServer((req, res) => {
 res.setHeader('Content-Type', 'text/html');
 res.setHeader('X-Foo', 'bar');
 res.writeHead(200, { 'Content-Type': 'text/plain; charset=utf-8' });
 res.writeHead(200, {
 'Content-Type': 'text/plain; charset=utf-8',
 'X-Foo': 'bar',
 });
 res.end('ok');
});
```
Expand DownExpand Up@@ -5081,6 +5219,7 @@ you need to implement any fall-back behavior yourself.
[HTTP/2 Settings Object]: #settings-object
[HTTP/2 Unencrypted]: https://http2.github.io/faq/#does-http2-require-encryption
[HTTPS]: https.md
[Invalid character handling in header names and values]: #invalid-character-handling-in-header-names-and-values
[Performance Observer]: perf_hooks.md
[RFC 7838]: https://tools.ietf.org/html/rfc7838
[RFC 8336]: https://tools.ietf.org/html/rfc8336
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
doc: document http2 header constants#64548

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

 Merged

nodejs-github-bot
merged 1 commit into

from

Aug 14, 2026
 Merged


doc: document http2 header constants
#64548
 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


151 changes: 145 additions & 6 deletions
doc/api/http2.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3404,6 +3404,142 @@ client.close();
added: v8.4.0
-->

#### Header name constants

The `HTTP2_HEADER_*` constants provide names for HTTP/2 pseudo-headers and
known HTTP header names. Using these string constants is optional. For example,
`http2.constants.HTTP2_HEADER_CONTENT_TYPE` is equal to `'content-type'`.
For APIs that accept regular header names,
`http2.constants.HTTP2_HEADER_CONTENT_TYPE`, `'content-type'`, and
`'Content-Type'` have the same effect; Node.js serializes the name in
lower-case.

Regular header constants can be used with the compatibility API wherever the
corresponding literal header name is accepted. In compatibility API request
handlers, prefer `request.method`, `request.authority`, `request.scheme`, and
`request.url` for the corresponding pseudo-headers. Other incoming
pseudo-headers remain available through `request.headers`. Set response status
through `response.statusCode` or the `statusCode` argument to
`response.writeHead()`. Passing `HTTP2_HEADER_STATUS` (`':status'`) to
`response.setHeader()` or in `response.writeHead()`'s headers object throws
`ERR_HTTP2_PSEUDOHEADER_NOT_ALLOWED`. `HTTP2_HEADER_PROTOCOL` is a request
pseudo-header and cannot be sent in a response.

Incoming header object keys are lower-case, so use a constant or a lower-case
literal when accessing them as object properties. Using a constant does not
change header validation, and the availability of a constant does not imply
that the header is valid in every HTTP/2 context. See [HTTP/2 Headers Object][]
and [Invalid character handling in header names and values][] for details about
header casing and validation.

##### Pseudo-header constants

`HTTP2_HEADER_METHOD`, `HTTP2_HEADER_AUTHORITY`, `HTTP2_HEADER_SCHEME`, and
`HTTP2_HEADER_PATH` identify request pseudo-headers. `HTTP2_HEADER_STATUS`
identifies the response pseudo-header. `HTTP2_HEADER_PROTOCOL` identifies the
extended `CONNECT` request pseudo-header. Pseudo-headers are not permitted in
trailers.

| Constant | Value |
| ---------------------------------------- | -------------- |
| `http2.constants.HTTP2_HEADER_STATUS` | `':status'` |
| `http2.constants.HTTP2_HEADER_METHOD` | `':method'` |
| `http2.constants.HTTP2_HEADER_AUTHORITY` | `':authority'` |
| `http2.constants.HTTP2_HEADER_SCHEME` | `':scheme'` |
| `http2.constants.HTTP2_HEADER_PATH` | `':path'` |
| `http2.constants.HTTP2_HEADER_PROTOCOL` | `':protocol'` |

##### Regular header constants

The `HTTP2_HEADER_CONNECTION`, `HTTP2_HEADER_UPGRADE`,
`HTTP2_HEADER_HTTP2_SETTINGS`, `HTTP2_HEADER_KEEP_ALIVE`,
`HTTP2_HEADER_PROXY_CONNECTION`, and `HTTP2_HEADER_TRANSFER_ENCODING`
constants identify connection-specific headers that HTTP/2 does not permit.
`HTTP2_HEADER_TE` is permitted only when its value is `'trailers'`.

| Constant | Value |
| --------------------------------------------------------------- | ------------------------------------ |
| `http2.constants.HTTP2_HEADER_ACCEPT_ENCODING` | `'accept-encoding'` |
| `http2.constants.HTTP2_HEADER_ACCEPT_LANGUAGE` | `'accept-language'` |
| `http2.constants.HTTP2_HEADER_ACCEPT_RANGES` | `'accept-ranges'` |
| `http2.constants.HTTP2_HEADER_ACCEPT` | `'accept'` |
| `http2.constants.HTTP2_HEADER_ACCESS_CONTROL_ALLOW_CREDENTIALS` | `'access-control-allow-credentials'` |
| `http2.constants.HTTP2_HEADER_ACCESS_CONTROL_ALLOW_HEADERS` | `'access-control-allow-headers'` |
| `http2.constants.HTTP2_HEADER_ACCESS_CONTROL_ALLOW_METHODS` | `'access-control-allow-methods'` |
| `http2.constants.HTTP2_HEADER_ACCESS_CONTROL_ALLOW_ORIGIN` | `'access-control-allow-origin'` |
| `http2.constants.HTTP2_HEADER_ACCESS_CONTROL_EXPOSE_HEADERS` | `'access-control-expose-headers'` |
| `http2.constants.HTTP2_HEADER_ACCESS_CONTROL_REQUEST_HEADERS` | `'access-control-request-headers'` |
| `http2.constants.HTTP2_HEADER_ACCESS_CONTROL_REQUEST_METHOD` | `'access-control-request-method'` |
| `http2.constants.HTTP2_HEADER_AGE` | `'age'` |
| `http2.constants.HTTP2_HEADER_AUTHORIZATION` | `'authorization'` |
| `http2.constants.HTTP2_HEADER_CACHE_CONTROL` | `'cache-control'` |
| `http2.constants.HTTP2_HEADER_CONNECTION` | `'connection'` |
| `http2.constants.HTTP2_HEADER_CONTENT_DISPOSITION` | `'content-disposition'` |
| `http2.constants.HTTP2_HEADER_CONTENT_ENCODING` | `'content-encoding'` |
| `http2.constants.HTTP2_HEADER_CONTENT_LENGTH` | `'content-length'` |
| `http2.constants.HTTP2_HEADER_CONTENT_TYPE` | `'content-type'` |
| `http2.constants.HTTP2_HEADER_COOKIE` | `'cookie'` |
| `http2.constants.HTTP2_HEADER_DATE` | `'date'` |
| `http2.constants.HTTP2_HEADER_ETAG` | `'etag'` |
| `http2.constants.HTTP2_HEADER_FORWARDED` | `'forwarded'` |
| `http2.constants.HTTP2_HEADER_HOST` | `'host'` |
| `http2.constants.HTTP2_HEADER_IF_MODIFIED_SINCE` | `'if-modified-since'` |
| `http2.constants.HTTP2_HEADER_IF_NONE_MATCH` | `'if-none-match'` |
| `http2.constants.HTTP2_HEADER_IF_RANGE` | `'if-range'` |
| `http2.constants.HTTP2_HEADER_LAST_MODIFIED` | `'last-modified'` |
| `http2.constants.HTTP2_HEADER_LINK` | `'link'` |
| `http2.constants.HTTP2_HEADER_LOCATION` | `'location'` |
| `http2.constants.HTTP2_HEADER_RANGE` | `'range'` |
| `http2.constants.HTTP2_HEADER_REFERER` | `'referer'` |
| `http2.constants.HTTP2_HEADER_SERVER` | `'server'` |
| `http2.constants.HTTP2_HEADER_SET_COOKIE` | `'set-cookie'` |
| `http2.constants.HTTP2_HEADER_STRICT_TRANSPORT_SECURITY` | `'strict-transport-security'` |
| `http2.constants.HTTP2_HEADER_TRANSFER_ENCODING` | `'transfer-encoding'` |
| `http2.constants.HTTP2_HEADER_TE` | `'te'` |
| `http2.constants.HTTP2_HEADER_UPGRADE_INSECURE_REQUESTS` | `'upgrade-insecure-requests'` |
| `http2.constants.HTTP2_HEADER_UPGRADE` | `'upgrade'` |
| `http2.constants.HTTP2_HEADER_USER_AGENT` | `'user-agent'` |
| `http2.constants.HTTP2_HEADER_VARY` | `'vary'` |
| `http2.constants.HTTP2_HEADER_X_CONTENT_TYPE_OPTIONS` | `'x-content-type-options'` |
| `http2.constants.HTTP2_HEADER_X_FRAME_OPTIONS` | `'x-frame-options'` |
| `http2.constants.HTTP2_HEADER_KEEP_ALIVE` | `'keep-alive'` |
| `http2.constants.HTTP2_HEADER_PROXY_CONNECTION` | `'proxy-connection'` |
| `http2.constants.HTTP2_HEADER_X_XSS_PROTECTION` | `'x-xss-protection'` |
| `http2.constants.HTTP2_HEADER_ALT_SVC` | `'alt-svc'` |
| `http2.constants.HTTP2_HEADER_CONTENT_SECURITY_POLICY` | `'content-security-policy'` |
| `http2.constants.HTTP2_HEADER_EARLY_DATA` | `'early-data'` |
| `http2.constants.HTTP2_HEADER_EXPECT_CT` | `'expect-ct'` |
| `http2.constants.HTTP2_HEADER_ORIGIN` | `'origin'` |
| `http2.constants.HTTP2_HEADER_PURPOSE` | `'purpose'` |
| `http2.constants.HTTP2_HEADER_TIMING_ALLOW_ORIGIN` | `'timing-allow-origin'` |
| `http2.constants.HTTP2_HEADER_X_FORWARDED_FOR` | `'x-forwarded-for'` |
| `http2.constants.HTTP2_HEADER_PRIORITY` | `'priority'` |
| `http2.constants.HTTP2_HEADER_ACCEPT_CHARSET` | `'accept-charset'` |
| `http2.constants.HTTP2_HEADER_ACCESS_CONTROL_MAX_AGE` | `'access-control-max-age'` |
| `http2.constants.HTTP2_HEADER_ALLOW` | `'allow'` |
| `http2.constants.HTTP2_HEADER_CONTENT_LANGUAGE` | `'content-language'` |
| `http2.constants.HTTP2_HEADER_CONTENT_LOCATION` | `'content-location'` |
| `http2.constants.HTTP2_HEADER_CONTENT_MD5` | `'content-md5'` |
| `http2.constants.HTTP2_HEADER_CONTENT_RANGE` | `'content-range'` |
| `http2.constants.HTTP2_HEADER_DNT` | `'dnt'` |
| `http2.constants.HTTP2_HEADER_EXPECT` | `'expect'` |
| `http2.constants.HTTP2_HEADER_EXPIRES` | `'expires'` |
| `http2.constants.HTTP2_HEADER_FROM` | `'from'` |
| `http2.constants.HTTP2_HEADER_IF_MATCH` | `'if-match'` |
| `http2.constants.HTTP2_HEADER_IF_UNMODIFIED_SINCE` | `'if-unmodified-since'` |
| `http2.constants.HTTP2_HEADER_MAX_FORWARDS` | `'max-forwards'` |
| `http2.constants.HTTP2_HEADER_PREFER` | `'prefer'` |
| `http2.constants.HTTP2_HEADER_PROXY_AUTHENTICATE` | `'proxy-authenticate'` |
| `http2.constants.HTTP2_HEADER_PROXY_AUTHORIZATION` | `'proxy-authorization'` |
| `http2.constants.HTTP2_HEADER_REFRESH` | `'refresh'` |
| `http2.constants.HTTP2_HEADER_RETRY_AFTER` | `'retry-after'` |
| `http2.constants.HTTP2_HEADER_TRAILER` | `'trailer'` |
| `http2.constants.HTTP2_HEADER_TK` | `'tk'` |
| `http2.constants.HTTP2_HEADER_VIA` | `'via'` |
| `http2.constants.HTTP2_HEADER_WARNING` | `'warning'` |
| `http2.constants.HTTP2_HEADER_WWW_AUTHENTICATE` | `'www-authenticate'` |
| `http2.constants.HTTP2_HEADER_HTTP2_SETTINGS` | `'http2-settings'` |

#### Error codes for `RST_STREAM` and `GOAWAY`

| Value | Name | Constant |
Expand DownExpand Up@@ -3970,19 +4106,21 @@ API:
```mjs
import { createServer } from 'node:http2';
const server = createServer((req, res) => {
 res.setHeader('Content-Type', 'text/html');
 res.setHeader('X-Foo', 'bar');
 res.writeHead(200, { 'Content-Type': 'text/plain; charset=utf-8' });
 res.writeHead(200, {
 'Content-Type': 'text/plain; charset=utf-8',
 'X-Foo': 'bar',
 });
 res.end('ok');
});
```

```cjs
const http2 = require('node:http2');
const server = http2.createServer((req, res) => {
 res.setHeader('Content-Type', 'text/html');
 res.setHeader('X-Foo', 'bar');
 res.writeHead(200, { 'Content-Type': 'text/plain; charset=utf-8' });
 res.writeHead(200, {
 'Content-Type': 'text/plain; charset=utf-8',
 'X-Foo': 'bar',
 });
 res.end('ok');
});
```
Expand DownExpand Up@@ -5081,6 +5219,7 @@ you need to implement any fall-back behavior yourself.
[HTTP/2 Settings Object]: #settings-object
[HTTP/2 Unencrypted]: https://http2.github.io/faq/#does-http2-require-encryption
[HTTPS]: https.md
[Invalid character handling in header names and values]: #invalid-character-handling-in-header-names-and-values
[Performance Observer]: perf_hooks.md
[RFC 7838]: https://tools.ietf.org/html/rfc7838
[RFC 8336]: https://tools.ietf.org/html/rfc8336
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
doc: document http2 header constants#64548

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

 Merged

nodejs-github-bot
merged 1 commit into

from

Aug 14, 2026
 Merged


doc: document http2 header constants
#64548
 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


151 changes: 145 additions & 6 deletions
doc/api/http2.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3404,6 +3404,142 @@ client.close();
added: v8.4.0
-->

#### Header name constants

The `HTTP2_HEADER_*` constants provide names for HTTP/2 pseudo-headers and
known HTTP header names. Using these string constants is optional. For example,
`http2.constants.HTTP2_HEADER_CONTENT_TYPE` is equal to `'content-type'`.
For APIs that accept regular header names,
`http2.constants.HTTP2_HEADER_CONTENT_TYPE`, `'content-type'`, and
`'Content-Type'` have the same effect; Node.js serializes the name in
lower-case.

Regular header constants can be used with the compatibility API wherever the
corresponding literal header name is accepted. In compatibility API request
handlers, prefer `request.method`, `request.authority`, `request.scheme`, and
`request.url` for the corresponding pseudo-headers. Other incoming
pseudo-headers remain available through `request.headers`. Set response status
through `response.statusCode` or the `statusCode` argument to
`response.writeHead()`. Passing `HTTP2_HEADER_STATUS` (`':status'`) to
`response.setHeader()` or in `response.writeHead()`'s headers object throws
`ERR_HTTP2_PSEUDOHEADER_NOT_ALLOWED`. `HTTP2_HEADER_PROTOCOL` is a request
pseudo-header and cannot be sent in a response.

Incoming header object keys are lower-case, so use a constant or a lower-case
literal when accessing them as object properties. Using a constant does not
change header validation, and the availability of a constant does not imply
that the header is valid in every HTTP/2 context. See [HTTP/2 Headers Object][]
and [Invalid character handling in header names and values][] for details about
header casing and validation.

##### Pseudo-header constants

`HTTP2_HEADER_METHOD`, `HTTP2_HEADER_AUTHORITY`, `HTTP2_HEADER_SCHEME`, and
`HTTP2_HEADER_PATH` identify request pseudo-headers. `HTTP2_HEADER_STATUS`
identifies the response pseudo-header. `HTTP2_HEADER_PROTOCOL` identifies the
extended `CONNECT` request pseudo-header. Pseudo-headers are not permitted in
trailers.

| Constant | Value |
| ---------------------------------------- | -------------- |
| `http2.constants.HTTP2_HEADER_STATUS` | `':status'` |
| `http2.constants.HTTP2_HEADER_METHOD` | `':method'` |
| `http2.constants.HTTP2_HEADER_AUTHORITY` | `':authority'` |
| `http2.constants.HTTP2_HEADER_SCHEME` | `':scheme'` |
| `http2.constants.HTTP2_HEADER_PATH` | `':path'` |
| `http2.constants.HTTP2_HEADER_PROTOCOL` | `':protocol'` |

##### Regular header constants

The `HTTP2_HEADER_CONNECTION`, `HTTP2_HEADER_UPGRADE`,
`HTTP2_HEADER_HTTP2_SETTINGS`, `HTTP2_HEADER_KEEP_ALIVE`,
`HTTP2_HEADER_PROXY_CONNECTION`, and `HTTP2_HEADER_TRANSFER_ENCODING`
constants identify connection-specific headers that HTTP/2 does not permit.
`HTTP2_HEADER_TE` is permitted only when its value is `'trailers'`.

| Constant | Value |
| --------------------------------------------------------------- | ------------------------------------ |
| `http2.constants.HTTP2_HEADER_ACCEPT_ENCODING` | `'accept-encoding'` |
| `http2.constants.HTTP2_HEADER_ACCEPT_LANGUAGE` | `'accept-language'` |
| `http2.constants.HTTP2_HEADER_ACCEPT_RANGES` | `'accept-ranges'` |
| `http2.constants.HTTP2_HEADER_ACCEPT` | `'accept'` |
| `http2.constants.HTTP2_HEADER_ACCESS_CONTROL_ALLOW_CREDENTIALS` | `'access-control-allow-credentials'` |
| `http2.constants.HTTP2_HEADER_ACCESS_CONTROL_ALLOW_HEADERS` | `'access-control-allow-headers'` |
| `http2.constants.HTTP2_HEADER_ACCESS_CONTROL_ALLOW_METHODS` | `'access-control-allow-methods'` |
| `http2.constants.HTTP2_HEADER_ACCESS_CONTROL_ALLOW_ORIGIN` | `'access-control-allow-origin'` |
| `http2.constants.HTTP2_HEADER_ACCESS_CONTROL_EXPOSE_HEADERS` | `'access-control-expose-headers'` |
| `http2.constants.HTTP2_HEADER_ACCESS_CONTROL_REQUEST_HEADERS` | `'access-control-request-headers'` |
| `http2.constants.HTTP2_HEADER_ACCESS_CONTROL_REQUEST_METHOD` | `'access-control-request-method'` |
| `http2.constants.HTTP2_HEADER_AGE` | `'age'` |
| `http2.constants.HTTP2_HEADER_AUTHORIZATION` | `'authorization'` |
| `http2.constants.HTTP2_HEADER_CACHE_CONTROL` | `'cache-control'` |
| `http2.constants.HTTP2_HEADER_CONNECTION` | `'connection'` |
| `http2.constants.HTTP2_HEADER_CONTENT_DISPOSITION` | `'content-disposition'` |
| `http2.constants.HTTP2_HEADER_CONTENT_ENCODING` | `'content-encoding'` |
| `http2.constants.HTTP2_HEADER_CONTENT_LENGTH` | `'content-length'` |
| `http2.constants.HTTP2_HEADER_CONTENT_TYPE` | `'content-type'` |
| `http2.constants.HTTP2_HEADER_COOKIE` | `'cookie'` |
| `http2.constants.HTTP2_HEADER_DATE` | `'date'` |
| `http2.constants.HTTP2_HEADER_ETAG` | `'etag'` |
| `http2.constants.HTTP2_HEADER_FORWARDED` | `'forwarded'` |
| `http2.constants.HTTP2_HEADER_HOST` | `'host'` |
| `http2.constants.HTTP2_HEADER_IF_MODIFIED_SINCE` | `'if-modified-since'` |
| `http2.constants.HTTP2_HEADER_IF_NONE_MATCH` | `'if-none-match'` |
| `http2.constants.HTTP2_HEADER_IF_RANGE` | `'if-range'` |
| `http2.constants.HTTP2_HEADER_LAST_MODIFIED` | `'last-modified'` |
| `http2.constants.HTTP2_HEADER_LINK` | `'link'` |
| `http2.constants.HTTP2_HEADER_LOCATION` | `'location'` |
| `http2.constants.HTTP2_HEADER_RANGE` | `'range'` |
| `http2.constants.HTTP2_HEADER_REFERER` | `'referer'` |
| `http2.constants.HTTP2_HEADER_SERVER` | `'server'` |
| `http2.constants.HTTP2_HEADER_SET_COOKIE` | `'set-cookie'` |
| `http2.constants.HTTP2_HEADER_STRICT_TRANSPORT_SECURITY` | `'strict-transport-security'` |
| `http2.constants.HTTP2_HEADER_TRANSFER_ENCODING` | `'transfer-encoding'` |
| `http2.constants.HTTP2_HEADER_TE` | `'te'` |
| `http2.constants.HTTP2_HEADER_UPGRADE_INSECURE_REQUESTS` | `'upgrade-insecure-requests'` |
| `http2.constants.HTTP2_HEADER_UPGRADE` | `'upgrade'` |
| `http2.constants.HTTP2_HEADER_USER_AGENT` | `'user-agent'` |
| `http2.constants.HTTP2_HEADER_VARY` | `'vary'` |
| `http2.constants.HTTP2_HEADER_X_CONTENT_TYPE_OPTIONS` | `'x-content-type-options'` |
| `http2.constants.HTTP2_HEADER_X_FRAME_OPTIONS` | `'x-frame-options'` |
| `http2.constants.HTTP2_HEADER_KEEP_ALIVE` | `'keep-alive'` |
| `http2.constants.HTTP2_HEADER_PROXY_CONNECTION` | `'proxy-connection'` |
| `http2.constants.HTTP2_HEADER_X_XSS_PROTECTION` | `'x-xss-protection'` |
| `http2.constants.HTTP2_HEADER_ALT_SVC` | `'alt-svc'` |
| `http2.constants.HTTP2_HEADER_CONTENT_SECURITY_POLICY` | `'content-security-policy'` |
| `http2.constants.HTTP2_HEADER_EARLY_DATA` | `'early-data'` |
| `http2.constants.HTTP2_HEADER_EXPECT_CT` | `'expect-ct'` |
| `http2.constants.HTTP2_HEADER_ORIGIN` | `'origin'` |
| `http2.constants.HTTP2_HEADER_PURPOSE` | `'purpose'` |
| `http2.constants.HTTP2_HEADER_TIMING_ALLOW_ORIGIN` | `'timing-allow-origin'` |
| `http2.constants.HTTP2_HEADER_X_FORWARDED_FOR` | `'x-forwarded-for'` |
| `http2.constants.HTTP2_HEADER_PRIORITY` | `'priority'` |
| `http2.constants.HTTP2_HEADER_ACCEPT_CHARSET` | `'accept-charset'` |
| `http2.constants.HTTP2_HEADER_ACCESS_CONTROL_MAX_AGE` | `'access-control-max-age'` |
| `http2.constants.HTTP2_HEADER_ALLOW` | `'allow'` |
| `http2.constants.HTTP2_HEADER_CONTENT_LANGUAGE` | `'content-language'` |
| `http2.constants.HTTP2_HEADER_CONTENT_LOCATION` | `'content-location'` |
| `http2.constants.HTTP2_HEADER_CONTENT_MD5` | `'content-md5'` |
| `http2.constants.HTTP2_HEADER_CONTENT_RANGE` | `'content-range'` |
| `http2.constants.HTTP2_HEADER_DNT` | `'dnt'` |
| `http2.constants.HTTP2_HEADER_EXPECT` | `'expect'` |
| `http2.constants.HTTP2_HEADER_EXPIRES` | `'expires'` |
| `http2.constants.HTTP2_HEADER_FROM` | `'from'` |
| `http2.constants.HTTP2_HEADER_IF_MATCH` | `'if-match'` |
| `http2.constants.HTTP2_HEADER_IF_UNMODIFIED_SINCE` | `'if-unmodified-since'` |
| `http2.constants.HTTP2_HEADER_MAX_FORWARDS` | `'max-forwards'` |
| `http2.constants.HTTP2_HEADER_PREFER` | `'prefer'` |
| `http2.constants.HTTP2_HEADER_PROXY_AUTHENTICATE` | `'proxy-authenticate'` |
| `http2.constants.HTTP2_HEADER_PROXY_AUTHORIZATION` | `'proxy-authorization'` |
| `http2.constants.HTTP2_HEADER_REFRESH` | `'refresh'` |
| `http2.constants.HTTP2_HEADER_RETRY_AFTER` | `'retry-after'` |
| `http2.constants.HTTP2_HEADER_TRAILER` | `'trailer'` |
| `http2.constants.HTTP2_HEADER_TK` | `'tk'` |
| `http2.constants.HTTP2_HEADER_VIA` | `'via'` |
| `http2.constants.HTTP2_HEADER_WARNING` | `'warning'` |
| `http2.constants.HTTP2_HEADER_WWW_AUTHENTICATE` | `'www-authenticate'` |
| `http2.constants.HTTP2_HEADER_HTTP2_SETTINGS` | `'http2-settings'` |

#### Error codes for `RST_STREAM` and `GOAWAY`

| Value | Name | Constant |
Expand DownExpand Up@@ -3970,19 +4106,21 @@ API:
```mjs
import { createServer } from 'node:http2';
const server = createServer((req, res) => {
 res.setHeader('Content-Type', 'text/html');
 res.setHeader('X-Foo', 'bar');
 res.writeHead(200, { 'Content-Type': 'text/plain; charset=utf-8' });
 res.writeHead(200, {
 'Content-Type': 'text/plain; charset=utf-8',
 'X-Foo': 'bar',
 });
 res.end('ok');
});
```

```cjs
const http2 = require('node:http2');
const server = http2.createServer((req, res) => {
 res.setHeader('Content-Type', 'text/html');
 res.setHeader('X-Foo', 'bar');
 res.writeHead(200, { 'Content-Type': 'text/plain; charset=utf-8' });
 res.writeHead(200, {
 'Content-Type': 'text/plain; charset=utf-8',
 'X-Foo': 'bar',
 });
 res.end('ok');
});
```
Expand DownExpand Up@@ -5081,6 +5219,7 @@ you need to implement any fall-back behavior yourself.
[HTTP/2 Settings Object]: #settings-object
[HTTP/2 Unencrypted]: https://http2.github.io/faq/#does-http2-require-encryption
[HTTPS]: https.md
[Invalid character handling in header names and values]: #invalid-character-handling-in-header-names-and-values
[Performance Observer]: perf_hooks.md
[RFC 7838]: https://tools.ietf.org/html/rfc7838
[RFC 8336]: https://tools.ietf.org/html/rfc8336
Expand Down
Loading