docs(firestore): update types & ios return null

invertase · Jun 3, 2020 · 27aaa62 · 27aaa62 · Salakar · Jun 3, 2020
1 parent 6d0598e
commit 27aaa62
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 1 deletion.
diff --git a/packages/firestore/ios/RNFBFirestore/RNFBFirestoreModule.m b/packages/firestore/ios/RNFBFirestore/RNFBFirestoreModule.m
@@ -112,7 +112,7 @@ + (BOOL)requiresMainQueueSetup {
     if (error) {
       [RNFBFirestoreCommon promiseRejectFirestoreException:reject error:error];
     } else {
-      resolve(nil);
+      resolve([NSNull null]);
     }
   }];
 }

diff --git a/packages/firestore/lib/index.d.ts b/packages/firestore/lib/index.d.ts
@@ -1939,6 +1939,17 @@ export namespace FirebaseFirestoreTypes {
      * @param settings A `Settings` object.
      */
     settings(settings: Settings): Promise<void>;
+    /**
+     * Aimed primarily at clearing up any data cached from running tests. Needs to be executed before any database calls
+     * are made.
+     *
+     * #### Example
+     *
+     *```js
+     * await firebase.firestore().clearPersistence();
+     * ```
+     */
+    clearPersistence(): Promise<null>;
   }
 }