Skip to content
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

Updated documentation for compat to include new database APIs #6252

Merged
merged 4 commits into from
May 11, 2022
Merged

Updated documentation for compat to include new database APIs #6252

merged 4 commits into from
May 11, 2022

Conversation

maneesht
Copy link
Contributor

@maneesht maneesht commented May 9, 2022 •
edited
Loading

Included INTERNAL properties in type definitions.

@changeset-bot
Copy link

changeset-bot bot commented May 9, 2022 •
edited
Loading

⚠️ No Changeset found

Latest commit: e9718fc

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

google-oss-bot commented May 9, 2022 •
edited
Loading

Size Report 1

Affected Products

  • @firebase/performance

    TypeBase (e15e895)Merge (690acd5)Diff
    browser28.5 kB29.1 kB+604 B (+2.1%)
    esm530.2 kB30.8 kB+604 B (+2.0%)
    main30.6 kB31.2 kB+604 B (+2.0%)
    module28.5 kB29.1 kB+604 B (+2.1%)

  • bundle

    TypeBase (e15e895)Merge (690acd5)Diff
    performance (trace)49.2 kB49.5 kB+364 B (+0.7%)

  • firebase

    TypeBase (e15e895)Merge (690acd5)Diff
    firebase-auth-react-native.js495 kB495 kB-23 B (-0.0%)
    firebase-compat.js783 kB783 kB+313 B (+0.0%)
    firebase-performance-compat.js30.4 kB30.7 kB+313 B (+1.0%)
    firebase-performance-standalone-compat.es2017.js87.1 kB87.4 kB+345 B (+0.4%)
    firebase-performance-standalone-compat.js64.9 kB65.3 kB+313 B (+0.5%)
    firebase-performance.js123 kB123 kB+769 B (+0.6%)

Test Logs

  1. https://storage.googleapis.com/firebase-sdk-metric-reports/5FMmzoeqoH.html

@google-oss-bot
Copy link
Contributor

google-oss-bot commented May 9, 2022 •
edited
Loading

Size Analysis Report 1

Affected Products

  • @firebase/database

    • DataSnapshot

    • Database

    • OnDisconnect

    • QueryConstraint

    • TransactionResult

    • _QueryImpl

    • _QueryParams

    • _ReferenceImpl

    • _TEST_ACCESS_forceRestClient

    • _TEST_ACCESS_hijackHash

    • _repoManagerDatabaseFromApp

    • _setSDKVersion

    • _validatePathString

    • _validateWritablePath

    • child

    • connectDatabaseEmulator

    • enableLogging

    • endAt

    • endBefore

    • equalTo

    • forceLongPolling

    • forceWebSockets

    • get

    • getDatabase

    • goOffline

    • goOnline

    • increment

    • limitToFirst

    • limitToLast

    • off

    • onChildAdded

    • onChildChanged

    • onChildMoved

    • onChildRemoved

    • onDisconnect

    • onValue

    • orderByChild

    • orderByKey

    • orderByPriority

    • orderByValue

    • push

    • query

    • ref

    • refFromURL

    • remove

    • runTransaction

    • serverTimestamp

    • set

    • setPriority

    • setWithPriority

    • startAfter

    • startAt

    • update

  • @firebase/performance

    • getPerformance

      Size

      TypeBase (e15e895)Merge (690acd5)Diff
      size17.6 kB18.0 kB+364 B (+2.1%)
      size-with-ext-deps43.0 kB43.4 kB+364 B (+0.8%)

    • initializePerformance

      Size

      TypeBase (e15e895)Merge (690acd5)Diff
      size17.8 kB18.2 kB+364 B (+2.0%)
      size-with-ext-deps43.4 kB43.8 kB+364 B (+0.8%)

    • trace

      Size

      TypeBase (e15e895)Merge (690acd5)Diff
      size17.5 kB17.9 kB+354 B (+2.0%)
      size-with-ext-deps42.9 kB43.2 kB+364 B (+0.8%)

Test Logs

  1. https://storage.googleapis.com/firebase-sdk-metric-reports/B1HmCTz7IN.html

hsubox76
hsubox76 reviewed May 10, 2022
View reviewed changes
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.

Thanks, I will add @egilmorez from the tech writers team to review as well, so wait for his approval also.

packages/firebase/compat/index.d.ts Outdated
*/
delete: () => Promise<void>;
/**
* Force the use of websockets instead of longPolling.
Copy link
Contributor

Choose a reason for hiding this comment

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

longPolling => long polling
websockets => WebSockets

@hsubox76 hsubox76 requested a review from egilmorez May 10, 2022 18:29
@maneesht maneesht assigned egilmorez and unassigned egilmorez and hsubox76 May 11, 2022
egilmorez
egilmorez approved these changes May 11, 2022
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.

LG, thanks!

@maneesht maneesht merged commit c424340 into master May 11, 2022
@maneesht maneesht deleted the mtewani/rtdb-transport-api-docs branch May 11, 2022 22:38
@firebase firebase locked and limited conversation to collaborators Jun 11, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@Nantris Nantris Nantris left review comments

@jsdt jsdt jsdt approved these changes

@egilmorez egilmorez egilmorez approved these changes

@hsubox76 hsubox76 hsubox76 approved these changes

@allspain allspain Awaiting requested review from allspain

Assignees

@egilmorez egilmorez

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@maneesht @google-oss-bot @jsdt @egilmorez @Nantris @hsubox76