Skip to content

Update prune-dts to allow beta APIs #6633

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 28, 2022
Merged

Update prune-dts to allow beta APIs #6633

merged 1 commit into from
Sep 28, 2022

Conversation

hsubox76
Copy link
Contributor

Update prune-dts (only used by Firestore I think) to allow beta APIs to get through (this seems to be the default behavior when using api-documenter). I think this is because api-documenter uses the *.api.json files and prune-dts filters out beta APIs before they even get into the json, whereas api-extractor puts everything in the json, and only filters what it puts into the public *.d.ts file.

Also an overload was recently added to getFirestore() which causes {@link getFirestore} to no longer work, leaving only a blank space in its place in reference docs. Fixed this by specifying the overload.

Also regenerated the firestore.api.md file after these changes.

@changeset-bot
Copy link

changeset-bot bot commented Sep 27, 2022

⚠️ No Changeset found

Latest commit: 7e7e4dc

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@google-oss-bot
Copy link
Contributor

@hsubox76 hsubox76 marked this pull request as ready for review September 27, 2022 22:01
@hsubox76 hsubox76 requested a review from wu-hui September 27, 2022 22:02
@hsubox76 hsubox76 mentioned this pull request Sep 27, 2022
Copy link
Contributor

@dwyfrequency dwyfrequency left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@wu-hui wu-hui merged commit e336946 into master Sep 28, 2022
@wu-hui wu-hui deleted the ch-docfix3 branch September 28, 2022 15:17
@firebase firebase locked and limited conversation to collaborators Oct 29, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants