Skip to content

Add database@exp API docs #4738

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 2 commits into from
Apr 6, 2021
Merged

Add database@exp API docs #4738

merged 2 commits into from
Apr 6, 2021

Conversation

schmidt-sebastian
Copy link
Contributor

No description provided.

@schmidt-sebastian schmidt-sebastian requested a review from jsdt as a code owner April 6, 2021 18:33
@changeset-bot
Copy link

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

⚠️ No Changeset found

Latest commit: 73c0ca1

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

@github-actions
Copy link
Contributor

github-actions bot commented Apr 6, 2021

Changeset File Check ⚠️

  • Warning: This PR modifies files in the following packages but they have not been included in the changeset file:

    • @firebase/firestore

    Make sure this was intentional.

  • Package @firebase/util has a major bump. Increase the bump for the main "firebase" package to major.

hsubox76
hsubox76 approved these changes Apr 6, 2021
View reviewed changes
packages/database/src/exp/OnDisconnect.ts Outdated
* Ensures the data at this location is deleted when the client is disconnected
* (due to closing the browser, navigating to a new page, or network issues).
*
* @return Resolves when synchronization to the server is complete.
Copy link
Contributor

Choose a reason for hiding this comment

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

I think I remember API documenter/extractor insists on @returns instead of @return but if you don't get an error when you run it, never mind.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fixed. There is no API report yet.

@google-oss-bot
Copy link
Contributor

Size Analysis Report

Affected Products

No changes between base commit (dd562b0) and head commit (23e59ca).

@schmidt-sebastian schmidt-sebastian merged commit b1d42b9 into database-exp-master Apr 6, 2021
@schmidt-sebastian schmidt-sebastian deleted the mrschmidt/docs branch April 6, 2021 19:12
Feiyang1 pushed a commit that referenced this pull request Apr 8, 2021
@schmidt-sebastian
Database exp (#4720)
7354a0e 
* Add database@exp API (#4614)

* Compat and @exp class for DataSnapshot (#4686)

* Add events to database@exp (#4694)

* Compat and @exp class for Database (#4705)

* Implement Query Compat and query@exp (#4709)

* Compat class for Reference (#4719)

* OnDisconnect Compat (#4727)

* ServerValues compat (#4728)

* EnableLogging Compat (#4730)

* Remove argument numbers from validation (#4729)

* Update changeset

* Add database@exp API docs (#4738)

* Add Support for API report (#4741)

* Update lets-go-travel.md

* Update enableLogging
Feiyang1 added a commit that referenced this pull request Apr 8, 2021
@Feiyang1 @schmidt-sebastian
Package database compat (#4753)
03e8422 
* Add database@exp API (#4614)

* Compat and @exp class for DataSnapshot (#4686)

* Add events to database@exp (#4694)

* Compat and @exp class for Database (#4705)

* Implement Query Compat and query@exp (#4709)

* Compat class for Reference (#4719)

* OnDisconnect Compat (#4727)

* ServerValues compat (#4728)

* EnableLogging Compat (#4730)

* Remove argument numbers from validation (#4729)

* Update changeset

* Add database@exp API docs (#4738)

* Add Support for API report (#4741)

* pacakge database compat

* export child as a public API

* address comments

* create database-compat dir

* create overloads for database-compat

* build database

* add database-compat to firebase-exp

* fix lint errors

* include compat in build

* fix typing errors

* fix script name

* make database types compatible

* use modular instance

Co-authored-by: Sebastian Schmidt <[email protected]>
@firebase firebase locked and limited conversation to collaborators May 7, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@hsubox76 hsubox76 hsubox76 approved these changes

@jsdt jsdt Awaiting requested review from jsdt

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@schmidt-sebastian @google-oss-bot @hsubox76