Skip to content
This repository was archived by the owner on Apr 4, 2023. It is now read-only.

Commit d6210dd

Browse files
committed
[docs][firestore] - Added documentation for firestore.settings()
1 parent 2883060 commit d6210dd

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

docs/FIRESTORE.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -378,3 +378,17 @@ firebase.firestore().runTransaction(transaction => {
378378
.then(() => console.log("Transaction successfully committed"))
379379
.catch(error => console.log(`Transaction error: ${error}`));
380380
```
381+
382+
### Firestore configurations: `settings()`
383+
> You must set these before invoking any other methods!
384+
385+
Setting cacheSizeBytes is Android only
386+
387+
You can modify `host`, `ssl` and `cacheSizeBytes`. (`timestampsInSnapshots` shouldn't be used as it will be deprecated)
388+
See [docs](https://firebase.google.com/docs/reference/js/firebase.firestore.Settings) for more information.
389+
390+
```typescript
391+
firebase.firestore.settings({});
392+
393+
firebaseWebApi.firestore().settings({"host" : "Example", "ssl" : false});
394+
```

0 commit comments

Comments
 (0)