Skip to content

Commit 71ce1f4

Browse files
author
Brian Chen
committed
update comments
1 parent 870d4ac commit 71ce1f4

File tree

2 files changed

+11
-3
lines changed

2 files changed

+11
-3
lines changed

packages/firebase/index.d.ts

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5988,7 +5988,8 @@ declare namespace firebase.firestore {
59885988
/**
59895989
* Attempts to enable persistent storage, if possible.
59905990
*
5991-
* Must be called before any other methods (other than settings()).
5991+
* Must be called before any other methods (other than settings() and
5992+
* clearPersistence()).
59925993
*
59935994
* If this fails, enablePersistence() will reject the promise it returns.
59945995
* Note that even after this failure, the firestore instance will remain
@@ -6061,7 +6062,13 @@ declare namespace firebase.firestore {
60616062
app: firebase.app.App;
60626063

60636064
/**
6064-
* Clears the persistence cache. This can only be called when the client is not running.
6065+
* Clears the persistent storage.
6066+
*
6067+
* Must be called after the app is shutdown or before other methods (other
6068+
* than settings()) on startup. If the client is still running, an exception
6069+
* `code` will be thrown.
6070+
*
6071+
* * failed-precondition: The app is still running in a browser tab.
60656072
*
60666073
* @return A promise that is resolved once the persistence has been cleared.
60676074
*/

packages/firestore-types/index.d.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -221,7 +221,8 @@ export class FirebaseFirestore {
221221
* Clears the persistent storage.
222222
*
223223
* Must be called after the app is shutdown or before other methods (other
224-
* than settings()). If the client is still running, an exception `code` will be thrown.
224+
* than settings()) on startup. If the client is still running, an exception
225+
* `code` will be thrown.
225226
*
226227
* * failed-precondition: The app is still running in a browser tab.
227228
*

0 commit comments

Comments
 (0)