docs: add restricted header info to ClientRequest docs #25075
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description of Change
Addresses #21148. (cc @nornagon)
Beginning in Electron 7, trying to set a
Host
header when creating a request withnet
throws a net::ERR_INVALID_ARGUMENT error. This is due to a Chromium change introduced in 7, where certain header types are now restricted from being set by a consumer.It doesn't seem like we'll be able to resolve this without patching Chrome directly, but this PR updates our docs to give developers a warning about what headers are restricted/will throw an error if set, and where they can find more information.
Note: I didn't add any release notes since this is a small doc change for something that has been present since 7.0.0, but happy to add a note if it would be helpful!
Checklist
npm test
passesRelease Notes
Notes: none