Skip to content

Fix documentation #4875

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 3 commits into from
May 10, 2021
Merged

Fix documentation #4875

merged 3 commits into from
May 10, 2021

Conversation

hsubox76
Copy link
Contributor

@hsubox76 hsubox76 commented May 6, 2021 •
edited
Loading

I forgot to update the main index.d.ts with the new AutoTokenRefresh param/method. Also added more comments.

Note: the second file (packages/firebase.index.d.ts) is the source for the autogenerated reference docs. The first file is for internal use.

@changeset-bot
Copy link

changeset-bot bot commented May 6, 2021 •
edited
Loading

⚠️ No Changeset found

Latest commit: cf07c73

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

@hsubox76 hsubox76 assigned kevinthecheung and unassigned egilmorez May 6, 2021
@google-oss-bot
Copy link
Contributor

google-oss-bot commented May 6, 2021 •
edited
Loading

Binary Size Report

Affected SDKs

  • @firebase/analytics

    Type Base (81c131a) Head (e0b096f) Diff
    esm2017 ? 18.7 kB ? (?)
    main ? 24.2 kB ? (?)
    module ? 23.4 kB ? (?)

  • @firebase/api-documenter

    Type Base (81c131a) Head (e0b096f) Diff
    main ? 3.72 kB ? (?)

  • @firebase/app

    Type Base (81c131a) Head (e0b096f) Diff
    browser ? 10.9 kB ? (?)
    esm2017 ? 9.63 kB ? (?)
    lite ? 8.95 kB ? (?)
    lite-esm2017 ? 7.93 kB ? (?)
    main ? 9.99 kB ? (?)
    module ? 10.9 kB ? (?)
    react-native ? 9.70 kB ? (?)

  • @firebase/app-check

    Type Base (81c131a) Head (e0b096f) Diff
    browser ? 20.7 kB ? (?)
    esm2017 ? 17.1 kB ? (?)
    main ? 20.7 kB ? (?)
    module ? 20.2 kB ? (?)

  • @firebase/auth

    Type Base (81c131a) Head (e0b096f) Diff
    browser ? 181 kB ? (?)
    main ? 181 kB ? (?)
    module ? 181 kB ? (?)

  • @firebase/component

    Type Base (81c131a) Head (e0b096f) Diff
    browser ? 7.84 kB ? (?)
    esm2017 ? 5.88 kB ? (?)
    main ? 8.18 kB ? (?)
    module ? 7.84 kB ? (?)

  • @firebase/database

    Type Base (81c131a) Head (e0b096f) Diff
    browser ? 296 kB ? (?)
    esm2017 ? 264 kB ? (?)
    main ? 298 kB ? (?)
    module ? 296 kB ? (?)

  • @firebase/database-compat

    Type Base (81c131a) Head (e0b096f) Diff
    browser ? 86.3 kB ? (?)
    main ? 102 kB ? (?)
    module ? 86.3 kB ? (?)

  • @firebase/database-exp

    Type Base (81c131a) Head (e0b096f) Diff
    browser ? 246 kB ? (?)
    main ? 278 kB ? (?)
    module ? 246 kB ? (?)

  • @firebase/firestore

    Type Base (81c131a) Head (e0b096f) Diff
    browser ? 284 kB ? (?)
    esm2017 ? 226 kB ? (?)
    main ? 531 kB ? (?)
    module ? 284 kB ? (?)
    react-native ? 226 kB ? (?)

  • @firebase/firestore-compat

    Type Base (81c131a) Head (e0b096f) Diff
    browser ? 28.6 kB ? (?)
    main ? 37.6 kB ? (?)
    module ? 28.6 kB ? (?)
    react-native ? 28.3 kB ? (?)

  • @firebase/firestore-exp

    Type Base (81c131a) Head (e0b096f) Diff
    browser ? 224 kB ? (?)
    main ? 507 kB ? (?)
    module ? 224 kB ? (?)
    react-native ? 224 kB ? (?)

  • @firebase/firestore-lite

    Type Base (81c131a) Head (e0b096f) Diff
    browser ? 72.4 kB ? (?)
    main ? 147 kB ? (?)
    module ? 72.4 kB ? (?)
    react-native ? 72.6 kB ? (?)

  • @firebase/firestore/bundle

    Type Base (81c131a) Head (e0b096f) Diff
    browser ? 290 kB ? (?)
    esm2017 ? 176 kB ? (?)
    main ? 527 kB ? (?)
    module ? 290 kB ? (?)
    react-native ? 176 kB ? (?)

  • @firebase/firestore/memory

    Type Base (81c131a) Head (e0b096f) Diff
    browser ? 216 kB ? (?)
    esm2017 ? 172 kB ? (?)
    main ? 325 kB ? (?)
    module ? 216 kB ? (?)
    react-native ? 172 kB ? (?)

  • @firebase/firestore/memory-bundle

    Type Base (81c131a) Head (e0b096f) Diff
    browser ? 224 kB ? (?)
    esm2017 ? 176 kB ? (?)
    main ? 322 kB ? (?)
    module ? 224 kB ? (?)
    react-native ? 176 kB ? (?)

  • @firebase/functions

    Type Base (81c131a) Head (e0b096f) Diff
    browser ? 10.6 kB ? (?)
    esm2017 ? 8.15 kB ? (?)
    main ? 11.0 kB ? (?)
    module ? 10.6 kB ? (?)

  • @firebase/installations

    Type Base (81c131a) Head (e0b096f) Diff
    esm2017 ? 16.6 kB ? (?)
    main ? 22.2 kB ? (?)
    module ? 21.6 kB ? (?)

  • @firebase/logger

    Type Base (81c131a) Head (e0b096f) Diff
    esm2017 ? 3.25 kB ? (?)
    main ? 5.38 kB ? (?)
    module ? 4.65 kB ? (?)

  • @firebase/messaging

    Type Base (81c131a) Head (e0b096f) Diff
    esm2017 ? 26.2 kB ? (?)
    main ? 34.9 kB ? (?)
    module ? 34.4 kB ? (?)

  • @firebase/performance

    Type Base (81c131a) Head (e0b096f) Diff
    browser ? 27.7 kB ? (?)
    esm2017 ? 25.9 kB ? (?)
    main ? 28.0 kB ? (?)
    module ? 27.7 kB ? (?)

  • @firebase/polyfill

    Type Base (81c131a) Head (e0b096f) Diff
    main ? 747 B ? (?)
    module ? 705 B ? (?)

  • @firebase/remote-config

    Type Base (81c131a) Head (e0b096f) Diff
    browser ? 22.4 kB ? (?)
    esm2017 ? 17.4 kB ? (?)
    main ? 23.0 kB ? (?)
    module ? 22.4 kB ? (?)

  • @firebase/rules-unit-testing

    Type Base (81c131a) Head (e0b096f) Diff
    main ? 14.8 kB ? (?)

  • @firebase/storage

    Type Base (81c131a) Head (e0b096f) Diff
    browser ? 63.4 kB ? (?)
    esm2017 ? 54.6 kB ? (?)
    main ? 63.8 kB ? (?)
    module ? 63.4 kB ? (?)

  • @firebase/storage-compat

    Type Base (81c131a) Head (e0b096f) Diff
    browser ? 10.2 kB ? (?)
    main ? 29.1 kB ? (?)
    module ? 10.2 kB ? (?)

  • @firebase/storage-exp

    Type Base (81c131a) Head (e0b096f) Diff
    browser ? 51.5 kB ? (?)
    main ? 52.6 kB ? (?)
    module ? 51.5 kB ? (?)

  • @firebase/util

    Type Base (81c131a) Head (e0b096f) Diff
    browser ? 21.2 kB ? (?)
    esm2017 ? 20.0 kB ? (?)
    main ? 25.8 kB ? (?)
    module ? 21.2 kB ? (?)

  • @firebase/webchannel-wrapper

    Type Base (81c131a) Head (e0b096f) Diff
    esm2017 ? 39.5 kB ? (?)
    main ? 46.9 kB ? (?)
    module ? 40.8 kB ? (?)

  • firebase

    Click to show 16 binary size changes.
    Type Base (81c131a) Head (e0b096f) Diff
    firebase-analytics.js ? 35.8 kB ? (?)
    firebase-app-check.js ? 22.0 kB ? (?)
    firebase-app.js ? 21.7 kB ? (?)
    firebase-auth.js ? 177 kB ? (?)
    firebase-database.js ? 187 kB ? (?)
    firebase-firestore.js ? 332 kB ? (?)
    firebase-firestore.memory.js ? 267 kB ? (?)
    firebase-functions.js ? 10.7 kB ? (?)
    firebase-installations.js ? 19.3 kB ? (?)
    firebase-messaging.js ? 41.0 kB ? (?)
    firebase-performance-standalone.es2017.js ? 73.1 kB ? (?)
    firebase-performance-standalone.js ? 49.7 kB ? (?)
    firebase-performance.js ? 38.3 kB ? (?)
    firebase-remote-config.js ? 36.9 kB ? (?)
    firebase-storage.js ? 41.6 kB ? (?)
    firebase.js ? 888 kB ? (?)

Test Logs

egilmorez
egilmorez reviewed May 6, 2021
View reviewed changes
Copy link
Contributor

@egilmorez egilmorez left a comment

Choose a reason for hiding this comment

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

Thanks for sending! Couple of things to look at.

packages/app-check-types/index.d.ts Outdated
/**
*
* @param isTokenAutoRefreshEnabled - If set to true, enables SDK to
* automatically refresh AppCheck token as needed. If false, disables this
Copy link
Contributor

Choose a reason for hiding this comment

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

Is this a literal? If not, maybe just App Check here and below (but is App Check actually publicly released right now?)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

No, it's not a literal, can change to App Check.

We are in a code freeze right now so the release will not happen until 5/11. The documentation can be published along with the rest on 5/13, see other comment.

kevinthecheung
kevinthecheung approved these changes May 6, 2021
View reviewed changes
@google-oss-bot
Copy link
Contributor

Size Analysis Report

Affected Products

Diffs between base commit (81c131a) and head commit (e0b096f) are too large (479,509 characters) to display.

Please check below links to see details from the original test log.

@hsubox76 hsubox76 merged commit 6e35e53 into master May 10, 2021
@hsubox76 hsubox76 deleted the ch-appcheck-docfix branch May 10, 2021 16:33
@firebase firebase locked and limited conversation to collaborators Jun 10, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@Feiyang1 Feiyang1 Feiyang1 left review comments

@egilmorez egilmorez egilmorez approved these changes

@kevinthecheung kevinthecheung kevinthecheung approved these changes

@hiranya911 hiranya911 Awaiting requested review from hiranya911

Assignees

@kevinthecheung kevinthecheung

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@hsubox76 @google-oss-bot @Feiyang1 @egilmorez @kevinthecheung