Exclude browser-only types from @firebase/util public types #6088
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
🦋 Changeset detectedLatest commit: 930307d The changes in this PR will be included in the next version bump. This PR includes changesets to release 28 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
egilmorez
approved these changes
Mar 21, 2022
allspain
approved these changes
Mar 22, 2022
Merged
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Use api-extractor's dtsRollup functionality to exclude browser-only native IndexedDB types from util's public typings. These typings are used in methods needed by other firebase packages for internal development, but end users don't need them.
common/api-review/util.api.mdis autogenerated by theapi-extractorprocess. Sinceutilisn't fully compliant yet, and we don't generate docs for it, it can be ignored for now.api-extractor.jsonfor util, since we don't care about any of the end products except the public typings file. We may fix it to be tsdoc compliant later for better auditing of util but it's low priority since there's no public facing docs or API.docgen.tshas been modified to prevent it generating devsite docs for util. It was also generating extraneous docs forapp-compat, so that's been excluded too.