Menentukan konfigurasi kustom untuk instance Cloud Firestore Anda. Anda harus menetapkannya sebelum memanggil metode lain.
Tanda Tangan:
export declare interface FirestoreSettings
Properti
| Properti | Jenis | Deskripsi |
|---|---|---|
| cacheSizeBytes | angka | CATATAN: Kolom ini tidak akan digunakan lagi dalam rilis utama mendatang. Sebagai gantinya, gunakan kolom cache untuk menentukan ukuran cache, dan konfigurasi cache lainnya.Perkiraan batas ukuran cache untuk data dalam disk. Jika cache membesar melebihi ukuran ini, Firestore akan mulai menghapus data yang tidak digunakan baru-baru ini. Ukurannya tidak menjamin bahwa cache akan tetap di bawah ukuran tersebut, hanya saja jika cache melebihi ukuran yang ditentukan, akan dilakukan pembersihan.Nilai defaultnya adalah 40 MB. Batas minimum harus disetel ke setidaknya 1 MB, dan dapat disetel ke CACHE_SIZE_UNLIMITED untuk menonaktifkan pembersihan sampah memori. |
| eksperimentalAutoDeteksiLongPolling | boolean | Mengonfigurasi transport dasar SDK (WebChannel) untuk otomatis mendeteksi apakah polling panjang harus digunakan. Hal ini sangat mirip dengan experimentalForceLongPolling, tetapi hanya menggunakan polling panjang jika diperlukan.Setelah memiliki nilai default false sejak diluncurkan pada tahun 2019, nilai default setelan ini diubah pada Mei 2023 menjadi true di Firebase JavaScript SDK v9.22.0. Artinya, deteksi otomatis polling panjang sekarang diaktifkan secara default. Untuk menonaktifkannya, setel setelan ini ke false, dan buka masalah GitHub untuk membagikan masalah yang memotivasi Anda untuk menonaktifkan deteksi otomatis polling panjang.Setelan ini tidak dapat digunakan di lingkungan Node.js. |
| eksperimentalForceLongPolling | boolean | Memaksa transportasi jaringan dasar SDK (WebChannel) untuk menggunakan polling panjang. Setiap respons dari backend akan segera ditutup setelah backend mengirimkan data (secara default respons tetap terbuka jika backend memiliki lebih banyak data untuk dikirim). Tindakan ini akan menghindari masalah ketidakcocokan dengan proxy tertentu, software antivirus, dll. yang salah melakukan buffering traffic tanpa batas waktu. Penggunaan opsi ini akan menyebabkan penurunan performa.Setelan ini tidak dapat digunakan dengan experimentalAutoDetectLongPolling dan dapat dihapus dalam rilis mendatang. Jika Anda menggunakannya untuk mengatasi masalah keandalan jaringan tertentu, harap beri tahu kami di https://github.com/firebase/firebase-js-sdk/issues/1674.Setelan ini tidak dapat digunakan di lingkungan Node.js. |
| LongPollingOptions eksperimental | EksperimentalLongPollingOptions | Opsi yang mengonfigurasi transportasi jaringan dasar SDK (WebChannel) saat polling panjang digunakan.Opsi ini hanya digunakan jika experimentalForceLongPolling benar atau jika experimentalAutoDetectLongPolling benar dan deteksi otomatis menentukan bahwa polling panjang diperlukan. Jika tidak, opsi ini tidak akan berpengaruh. |
| host | string | Nama host yang akan dihubungkan. |
| ignoreUndefinedProperties | boolean | Menentukan apakah akan melewati properti bertingkat yang ditetapkan ke undefined selama serialisasi objek. Jika ditetapkan ke true, properti ini akan dilewati dan tidak ditulis ke Firestore. Jika ditetapkan ke false atau dihilangkan, SDK akan menampilkan pengecualian saat menemukan properti jenis undefined. |
| localCache | FirestoreLocalCache | Menentukan cache yang digunakan oleh SDK. Opsi yang tersedia adalah MemoryLocalCache dan PersistentLocalCache, masing-masing dengan opsi konfigurasi berbeda.Jika tidak ditentukan, MemoryLocalCache akan digunakan secara default.CATATAN: menetapkan kolom ini dan cacheSizeBytes secara bersamaan akan menampilkan pengecualian selama inisialisasi SDK. Sebagai gantinya, gunakan konfigurasi dalam objek FirestoreLocalCache untuk menentukan ukuran cache. |
| ssl | boolean | Apakah akan menggunakan SSL saat menyambungkan. |
FirestoreSettings.cacheSizeBytes
CATATAN: Kolom ini tidak akan digunakan lagi dalam rilis utama mendatang. Sebagai gantinya, gunakan kolom cache untuk menentukan ukuran cache, dan konfigurasi cache lainnya.
Perkiraan batas ukuran cache untuk data dalam disk. Jika cache membesar melebihi ukuran ini, Firestore akan mulai menghapus data yang tidak digunakan baru-baru ini. Ukurannya tidak menjamin bahwa cache akan tetap di bawah ukuran tersebut, hanya saja jika cache melebihi ukuran yang diberikan, pembersihan akan dicoba.
Nilai defaultnya adalah 40 MB. Batas minimum harus disetel ke setidaknya 1 MB, dan dapat disetel ke CACHE_SIZE_UNLIMITED untuk menonaktifkan pembersihan sampah memori.
Tanda Tangan:
cacheSizeBytes?: number;
FirestoreSettings.experimentAutoDeteksiLongPolling
Mengonfigurasi transport dasar SDK (WebChannel) untuk otomatis mendeteksi apakah polling panjang harus digunakan. Hal ini sangat mirip dengan experimentalForceLongPolling, tetapi hanya menggunakan polling panjang jika diperlukan.
Setelah memiliki nilai default false sejak diluncurkan pada tahun 2019, nilai default setelan ini diubah pada Mei 2023 menjadi true di Firebase JavaScript SDK v9.22.0. Artinya, deteksi otomatis polling panjang sekarang diaktifkan secara default. Untuk menonaktifkannya, setel setelan ini ke false, dan buka masalah GitHub untuk membagikan masalah yang memotivasi Anda untuk menonaktifkan deteksi otomatis polling panjang.
Setelan ini tidak dapat digunakan di lingkungan Node.js.
Tanda Tangan:
experimentalAutoDetectLongPolling?: boolean;
FirestoreSettings.experimentForceLongPolling
Memaksa transportasi jaringan dasar SDK (WebChannel) untuk menggunakan polling panjang. Setiap respons dari backend akan segera ditutup setelah backend mengirimkan data (secara default respons tetap terbuka jika backend memiliki lebih banyak data untuk dikirim). Tindakan ini akan menghindari masalah ketidakcocokan dengan proxy tertentu, software antivirus, dll. yang salah melakukan buffering traffic tanpa batas waktu. Namun, penggunaan opsi ini akan menyebabkan penurunan performa.
Setelan ini tidak dapat digunakan dengan experimentalAutoDetectLongPolling dan dapat dihapus dalam rilis mendatang. Jika Anda menggunakannya untuk mengatasi masalah keandalan jaringan tertentu, beri tahu kami tentang hal ini di https://github.com/firebase/firebase-js-sdk/issues/1674.
Setelan ini tidak dapat digunakan di lingkungan Node.js.
Tanda Tangan:
experimentalForceLongPolling?: boolean;
FirestoreSettings.experimentLongPollingOptions
Opsi yang mengonfigurasi transportasi jaringan dasar SDK (WebChannel) saat polling panjang digunakan.
Opsi ini hanya digunakan jika experimentalForceLongPolling benar atau jika experimentalAutoDetectLongPolling benar dan deteksi otomatis menentukan bahwa polling panjang diperlukan. Jika tidak, opsi ini tidak akan berpengaruh.
Tanda Tangan:
experimentalLongPollingOptions?: ExperimentalLongPollingOptions;
FirestoreSettings.host
Nama host yang akan dihubungkan.
Tanda Tangan:
host?: string;
FirestoreSettings.ignoreUndefinedProperties
Menentukan apakah akan melewati properti bertingkat yang ditetapkan ke undefined selama serialisasi objek. Jika ditetapkan ke true, properti ini akan dilewati dan tidak ditulis ke Firestore. Jika ditetapkan ke false atau dihilangkan, SDK akan menampilkan pengecualian saat menemukan properti jenis undefined.
Tanda Tangan:
ignoreUndefinedProperties?: boolean;
FirestoreSettings.localCache
Menentukan cache yang digunakan oleh SDK. Opsi yang tersedia adalah MemoryLocalCache dan PersistentLocalCache, masing-masing dengan opsi konfigurasi yang berbeda.
Jika tidak ditentukan, MemoryLocalCache akan digunakan secara default.
CATATAN: menetapkan kolom ini dan cacheSizeBytes secara bersamaan akan menampilkan pengecualian selama inisialisasi SDK. Sebagai gantinya, gunakan konfigurasi dalam objek FirestoreLocalCache untuk menentukan ukuran cache.
Tanda Tangan:
localCache?: FirestoreLocalCache;
FirestoreSettings.ssl
Apakah akan menggunakan SSL saat menyambungkan.
Tanda Tangan:
ssl?: boolean;