fix(docs): rename Headers to HttpHeaders to avoid clash with DOM's Headers type #570
Conversation
This file contains 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
Codecov ReportBase: 100.00% // Head: 100.00% // No change to project coverage 👍
Additional details and impacted files@@ Coverage Diff @@
## master #570 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 33 33
Lines 1273 1273
Branches 306 306
=========================================
Hits 1273 1273 Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report at Codecov. |
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 PR renames the client's
Headerstype toHttpHeadersin order to avoid clashing with a built-in DOM Headers type.HttpHeadersare also exported asHeaders, so there is no backward-compatibility introduced herein.This change also fixes the model of the generated API documentation (created by api-extractor), the client's HttpHeaders now has a unique canonical name that is referenceable.
Checklist
yarn testcompletes successfully