Skip to content

Firestore lite overview #4861

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

Merged
merged 13 commits into from
May 13, 2021
Merged

Firestore lite overview #4861

Changes from 12 commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
978c9ed
Updating link.
egilmorez Jan 27, 2021
0643f4b
Merge branch 'master' of github.com:firebase/firebase-js-sdk into eg-…
egilmorez Apr 9, 2021
d2235ec
Adding comments for FirebaseOptions.
egilmorez Apr 11, 2021
f681558
Adding more detail requested in review.
egilmorez Apr 12, 2021
21988c3
Adding markdown output for these changes.
egilmorez Apr 12, 2021
1eb57cc
Changing markdown link to supported format.
egilmorez Apr 13, 2021
20a7dcd
Attempting merge. Frankly, I don't understand why I have to.
egilmorez Apr 13, 2021
36cd8ea
Merging.
egilmorez May 4, 2021
42858e7
Merge branch 'master' of github.com:firebase/firebase-js-sdk into eg-…
egilmorez May 4, 2021
3645733
Adding some explanation of Firestore Lite.
egilmorez May 4, 2021
d9dee4d
Attempting to merge this back to normal state.
egilmorez May 4, 2021
53225fe
Fixing typo.
egilmorez May 4, 2021
3a989d0
Update index.ts
schmidt-sebastian May 6, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions packages/firestore/lite/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,13 @@
/**
* Firestore Lite
*
* @remarks This package includes the same feature set as Firestore, but
* without latency compensation or snapshot listeners (and with
Copy link
Contributor

Choose a reason for hiding this comment

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

Do users know what these features are? What about something like this:

Firestore Lite is a small online-only SDK that allows read and write access to your Firestore database. All operations talk directly to the backend and onSnapshot() APIs are not supported.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

That sounds great! And . . . can you send a PR that adds it Sebastian?

I'm discouraged by the failing tests I see for this PR, as well as my ongoing inability to create a clean client (why do I seem to have 12 commits on a brand-new branch for which git status was clear?).

Quickest way forward that I can see is for me to drop this PR and for you or Fei to add the FL description. WDYT?

Copy link
Contributor

Choose a reason for hiding this comment

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

I can certainly take this to completion. Do you have rewording suggestions or should we take my suggestion as is? I would be disappointed if you didn't have an improvement in the back of your head :)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hehe, all I got is a comma and a substitution for "talk to," which the style guide says to avoid. How about:

"Firestore Lite is a small online-only SDK that allows read and write access to your Firestore database. All operations connect directly to the backend, and onSnapshot() APIs are not supported."

I tried re-running the CI jobs on Feiyang's advice, but it looks like I still have several tests failing. If you could take this Sebastian, that would be awesome.

Copy link
Contributor

Choose a reason for hiding this comment

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

Committed directly to this PR. Fingers crossed.

* correspondingly lighter size footprint). Firestore Lite supports fast
* write and read operations, but only when online.
* @packageDocumentation
*/

/**
* @license
* Copyright 2020 Google LLC
Expand Down