Skip to content

docs(firestore, increment): add warning about possible lost writes #6208

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 2 commits into from
Apr 22, 2022
Merged

docs(firestore, increment): add warning about possible lost writes #6208

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9416279
docs(firestore, increment): add warning about possible lost writes
mikehardy Apr 22, 2022
9605d34
docs(firestore, increment): make warning more serious but more vague …
mikehardy Apr 22, 2022
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
4 changes: 4 additions & 0 deletions packages/firestore/lib/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -720,6 +720,10 @@ export namespace FirebaseFirestoreTypes {
* });
* ```
*
* Please be careful using this operator. It may not be reliable enough for use in strict accounting, as it
* appears writes may be dropped in situations not fully understood yet, but possibly correlated with increment frequency.
* See https://github.com/invertase/react-native-firebase/discussions/5914
*
* @param n The value to increment by.
*/
static increment(n: number): FieldValue;
Expand Down