Skip to content

Commit 1f52e4d

Browse files
author
Brian Chen
committed
comment changes
1 parent acd7b24 commit 1f52e4d

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

packages/firestore-types/index.d.ts

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,8 @@ export class FirebaseFirestore {
136136
/**
137137
* Attempts to enable persistent storage, if possible.
138138
*
139-
* Must be called before any other methods (other than settings()).
139+
* Must be called before any other methods (other than settings() and
140+
* clearPersistence()).
140141
*
141142
* If this fails, enablePersistence() will reject the promise it returns.
142143
* Note that even after this failure, the firestore instance will remain
@@ -217,7 +218,12 @@ export class FirebaseFirestore {
217218
app: any;
218219

219220
/**
220-
* Clears the persistence cache. This can only be called when the client is not running.
221+
* Clears the persistent storage.
222+
*
223+
* 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.
225+
*
226+
* * failed-precondition: The app is still running in a browser tab.
221227
*
222228
* @return A promise that is resolved once the persistence has been cleared.
223229
*/

0 commit comments

Comments
 (0)