Skip to content

docs(fetch): document forbidden request headers #4871

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
nthbotast wants to merge 1 commit into from
+14 −0
Closed

docs(fetch): document forbidden request headers #4871

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
14 changes: 14 additions & 0 deletions docs/docs/api/Fetch.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,20 @@ This API is implemented as per the standard, you can find documentation on [MDN]

This API is implemented as per the standard, you can find documentation on [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Headers)

### Forbidden headers

Undici follows the Fetch specification rules for forbidden header names.
This means some browser-controlled headers cannot be set manually in
`fetch()` or `new Request()` calls.

For example, setting a `connection` header will throw an error such as
`InvalidArgumentError: invalid connection header`.

If your code is migrating from another HTTP client, remove these headers
and let Undici manage connection-level behavior.

See the [Fetch standard's list of forbidden request-header names](https://fetch.spec.whatwg.org/#forbidden-request-header).

# Body Mixins

`Response` and `Request` body inherit body mixin methods. These methods include:
Expand Down
Loading