make waitForPendingWrites public #2109
Conversation
I did add a CHANGELOG entry, now also fixed missing versions of previous entries. |
packages/firestore/CHANGELOG.md
Outdated
| @@ -1,23 +1,41 @@ | |||
|
|
|||
| # Unreleased | |||
| - [feature] Added a `waitForPendingWrites` method to `Firestore` class which | |||
There was a problem hiding this comment.
Thank you for the cleanup. Much appreciated! If you want to, you could include what you think the next version number should be - in this case, since we are adding a new feature, we should bump the minor version (to 1.5.0)
There was a problem hiding this comment.
You mean bump the version in package.json?
packages/firestore/CHANGELOG.md
Outdated
| @@ -1,23 +1,41 @@ | |||
|
|
|||
| # Unreleased | |||
| - [feature] Added a `waitForPendingWrites` method to `Firestore` class which | |||
| allows users to wait on a promise that resolves when all pending writes | |||
There was a problem hiding this comment.
s/to wait on a promise that resolves when all pending/to wait until all pending/
There was a problem hiding this comment.
Please remember to fix this since it is a bit shorter and no loss of information.
packages/firestore/CHANGELOG.md
Outdated
| @@ -1,23 +1,41 @@ | |||
|
|
|||
| # Unreleased | |||
| - [feature] Added a `waitForPendingWrites` method to `Firestore` class which | |||
There was a problem hiding this comment.
s/a waitForPendingWrites method to Firestore/Firestore.waitForPendingWrites()/
packages/firestore/CHANGELOG.md
Outdated
| @@ -29,7 +47,7 @@ | |||
| that you update your call to `enablePersistence()`. Firestore logs an error | |||
| if you continue to use `experimentalTabSynchronization`. | |||
| - [feature] You can now query across all collections in your database with a | |||
| given collection ID using the `FirebaseFirestore.collectionGroup()` method. | |||
| given collection ID using the `FirebaseFirestore.collis:openectionGroup()` method. | |||
packages/firestore/CHANGELOG.md
Outdated
| @@ -1,23 +1,41 @@ | |||
|
|
|||
| # Unreleased | |||
| - [feature] Added a `waitForPendingWrites` method to `Firestore` class which | |||
| allows users to wait on a promise that resolves when all pending writes | |||
There was a problem hiding this comment.
Please remember to fix this since it is a bit shorter and no loss of information.
packages/firestore/package.json
Outdated
| @@ -1,6 +1,6 @@ | |||
| { | |||
| "name": "@firebase/firestore", | |||
| "version": "1.4.10", | |||
| "version": "1.5.0", | |||
There was a problem hiding this comment.
Sorry I think there was a misunderstanding - the JS team updates these numbers. We can make their lives easier if we hint what version number we want in the changelog. What I intended was to change "Unreleased" to "Unreleased (1.5.0).". This is completely optional but please do revert the change in this file.
packages/firebase/index.d.ts
Outdated
| * The returned Promise resolves immediately if there are no outstanding writes. Otherwise, the | ||
| * Promise waits for all previously issued writes (including those written in a previous app | ||
| * session), but it does not wait for writes that were added after the method is called. If you | ||
| * wish to wait for additional writes, you have to call `waitForPendingWrites()` again. |
There was a problem hiding this comment.
Nit: we usually strive for an informal tone, preferring "want" over "wish."
packages/firebase/index.d.ts
Outdated
| * The returned Promise resolves immediately if there are no outstanding writes. Otherwise, the | ||
| * Promise waits for all previously issued writes (including those written in a previous app | ||
| * session), but it does not wait for writes that were added after the method is called. If you | ||
| * wish to wait for additional writes, you have to call `waitForPendingWrites()` again. |
There was a problem hiding this comment.
Suggest just "additional writes, call waitForPendingWrites() again."
packages/firestore/CHANGELOG.md
Outdated
| @@ -1,23 +1,41 @@ | |||
|
|
|||
| # Unreleased | |||
| # Unreleased (1.5.0) | |||
| - [feature] Added a `Firestore.waitForPendingWrites()` method which | |||
There was a problem hiding this comment.
I think this should be the restrictive "that," unless there other things the method does and we're just mentioning this one.
So, "that allows users to wait..."
No description provided.