Skip to content

Reference docs for Auth next #3883

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 2 commits into from
Oct 3, 2020
Merged

Reference docs for Auth next #3883

merged 2 commits into from
Oct 3, 2020

Conversation

Feiyang1
Copy link
Member

@Feiyang1 Feiyang1 commented Oct 1, 2020

  1. Integrate api-extractor into auth-next
  2. Generate API report for auth-next
  3. Generate reference docs for auth-next

There is a bunch of warning in the API report, which we should fix, e.g. adding documentation and release tag.

@changeset-bot
Copy link

changeset-bot bot commented Oct 1, 2020

⚠️ No Changeset found

Latest commit: bb675d4

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.

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

@sam-gc
Copy link
Contributor

sam-gc commented Oct 1, 2020

Is it possible to have it ignore _prefixed methods and properties?

@google-oss-bot
Copy link
Contributor

Binary Size Report

Affected SDKs

No changes between base commit (b6925be) and head commit (f1bb53c).

Test Logs

@google-oss-bot
Copy link
Contributor

Size Analysis Report

Affected Products

No changes between base commit (b6925be) and head commit (f1bb53c).

Test Logs

Copy link
Contributor

@hsubox76 hsubox76 left a comment

Choose a reason for hiding this comment

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

Wow, that is a lot of files.

@Feiyang1
Copy link
Member Author

Feiyang1 commented Oct 2, 2020

@samhorlbeck Yes! You can annotate those methods with @internal like this, then api-extractor can generate a rollup d.ts file with them removed.

@schmidt-sebastian is working on an utility that strips away _prefixed things automatically without the need to annotating them. It seems to be close to be ready, so you might want to wait for it if adding @internals feels too tedious.

@Feiyang1 Feiyang1 merged commit b73ab41 into master Oct 3, 2020
@Feiyang1 Feiyang1 deleted the fei-api-extractor-auth branch October 3, 2020 00:45
@firebase firebase locked and limited conversation to collaborators Nov 2, 2020
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.

5 participants