feat: Return lowercase header keys from getAllHeaders
#1187
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This is consistent with many other libraries (e.g. http, axios) and makes it easier to work with HTTP headers. The HTTP protocol states that header names are case-insensitive, so currently when using `getAllHeaders` you must worry about the case of the header name: ```js const headers = request.getAllHeaders(); const contentType = headers['Content-Type'] || headers['content-type']; // but what if someone sends us `Content-type`? ``` The existing `getHeader` method solved this by doing a case-insensitive search of all keys. Now, you can also safely use the lowercase key: ```js const headers = request.getAllHeaders(); const contentType = headers['content-type']; ``` BREAKING CHANGE: Header keys returned by `getAllHeaders` are converted to lowercase. Accessing headers through non-lowercase keys will yield `undefined`, even if the header in the request is in the same case. Use lowercase keys, or use `getHeader`.
|
🎉 This PR is included in version 2.0.0-beta.11 🎉 The release is available on: Your semantic-release bot 📦🚀 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This is consistent with many other libraries (e.g. http, axios) and makes it easier to work with HTTP headers.
The HTTP protocol states that header names are case-insensitive, so currently when using
getAllHeadersyou must worry about the case of the header name:The existing
getHeadermethod solved this by doing a case-insensitive search of all keys. Now, you can also safely use the lowercase key:Jira: ENG-2735
BREAKING CHANGE: Header keys returned by
getAllHeadersare converted to lowercase. Accessing headers through non-lowercase keys will yieldundefined, even if the header in the request is in the same case. Use lowercase keys, or usegetHeader.