Add comment documenting makeRequest#headers type. #1325
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.
r? @richardm-stripe
Summary
Adds a comment documenting why
HttpClient#makeRequest(headers)
doesn't use a stricter type. Unfortunately this is implementation-specific and enforcing a stricter type could break some integrations.As examples, we cannot just use
{[key: string]: string}
since:{[key: string]: string | number | string[]}
string[][]
as well as aHeaders
object.