Menentukan konfigurasi khusus untuk instance Cloud Firestore Anda. Anda harus mengaturnya sebelum menjalankan metode lainnya.
Tanda tangan:
export declare interface FirestoreSettings
Properti
| Properti | Jenis | Keterangan |
|---|---|---|
| cacheSizeBytes | nomor | CATATAN: Bidang ini tidak digunakan lagi pada rilis besar mendatang. Gunakan bidang cache untuk menentukan ukuran cache dan konfigurasi cache lainnya. Perkiraan ambang batas ukuran cache untuk data pada disk. Jika cache bertambah melebihi ukuran ini, Firestore akan mulai menghapus data yang baru-baru ini digunakan. Ukuran tersebut bukan jaminan bahwa cache akan tetap berada di bawah ukuran tersebut, hanya saja jika cache melebihi ukuran yang ditentukan, pembersihan akan dilakukan. Nilai defaultnya adalah 40 MB. Ambang batas harus disetel ke minimal 1 MB, dan dapat disetel ke CACHE_SIZE_UNLIMITED untuk menonaktifkan pengumpulan sampah. |
| eksperimentalAutoDetectLongPolling | boolean | Mengonfigurasi transport dasar SDK (WebChannel) untuk secara otomatis mendeteksi apakah polling panjang harus digunakan. Ini sangat mirip dengan experimentalForceLongPolling , tetapi hanya menggunakan polling panjang jika diperlukan. Setelah memiliki nilai default false sejak diperkenalkan 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 kini diaktifkan secara default. Untuk menonaktifkannya, setel pengaturan ini ke false , dan silakan buka masalah GitHub untuk berbagi masalah yang memotivasi Anda menonaktifkan deteksi otomatis jajak pendapat panjang. Pengaturan 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 ditutup segera setelah backend mengirimkan data (secara default, respons tetap terbuka jika backend memiliki lebih banyak data untuk dikirim). Hal ini untuk menghindari masalah ketidakcocokan dengan proxy tertentu, perangkat lunak antivirus, dll. yang melakukan buffering lalu lintas secara tidak tepat tanpa batas waktu. Penggunaan opsi ini akan menyebabkan penurunan kinerja. Pengaturan ini tidak dapat digunakan dengan experimentalAutoDetectLongPolling dan mungkin dihapus pada rilis mendatang. Jika Anda menggunakannya untuk mengatasi masalah keandalan jaringan tertentu, beri tahu kami tentang hal itu di https://github.com/firebase/firebase-js-sdk/issues/1674. Pengaturan ini tidak dapat digunakan di lingkungan Node.js. |
| eksperimentalLongPollingOptions | Opsi Polling Panjang Eksperimental | 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 jajak pendapat panjang diperlukan. Jika tidak, pilihan ini tidak akan berpengaruh. |
| tuan rumah | rangkaian | Nama host yang akan dihubungkan. |
| abaikanProperti Tidak Terdefinisi | boolean | Apakah akan melewati properti bertingkat yang disetel ke undefined selama serialisasi objek. Jika disetel ke true , properti ini akan dilewati dan tidak ditulis ke Firestore. Jika disetel ke false atau dihilangkan, SDK akan mengeluarkan pengecualian saat menemukan properti bertipe undefined . |
| cache lokal | 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: menyetel bidang ini dan cacheSizeBytes secara bersamaan akan memunculkan pengecualian selama inisialisasi SDK. Sebagai gantinya, gunakan konfigurasi di objek FirestoreLocalCache untuk menentukan ukuran cache. |
| sl | boolean | Apakah akan menggunakan SSL saat menghubungkan. |
FirestoreSettings.cacheSizeBytes
CATATAN: Bidang ini tidak digunakan lagi pada rilis besar mendatang. Gunakan bidang cache untuk menentukan ukuran cache dan konfigurasi cache lainnya.
Perkiraan ambang batas ukuran cache untuk data pada disk. Jika cache bertambah melebihi ukuran ini, Firestore akan mulai menghapus data yang baru-baru ini digunakan. Ukuran tersebut bukan jaminan bahwa cache akan tetap berada di bawah ukuran tersebut, hanya saja jika cache melebihi ukuran yang ditentukan, pembersihan akan dilakukan.
Nilai defaultnya adalah 40 MB. Ambang batas harus disetel ke minimal 1 MB, dan dapat disetel ke CACHE_SIZE_UNLIMITED untuk menonaktifkan pengumpulan sampah.
Tanda tangan:
cacheSizeBytes?: number;
FirestoreSettings.experimentalAutoDetectLongPolling
Mengonfigurasi transport dasar SDK (WebChannel) untuk secara otomatis mendeteksi apakah polling panjang harus digunakan. Ini sangat mirip dengan experimentalForceLongPolling , tetapi hanya menggunakan polling panjang jika diperlukan.
Setelah memiliki nilai default false sejak diperkenalkan 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 kini diaktifkan secara default. Untuk menonaktifkannya, setel pengaturan ini ke false , dan silakan buka terbitan GitHub untuk berbagi masalah yang memotivasi Anda menonaktifkan deteksi otomatis jajak pendapat panjang.
Pengaturan ini tidak dapat digunakan di lingkungan Node.js.
Tanda tangan:
experimentalAutoDetectLongPolling?: boolean;
FirestoreSettings.experimentalForceLongPolling
Memaksa transportasi jaringan dasar SDK (WebChannel) untuk menggunakan polling panjang. Setiap respons dari backend akan ditutup segera setelah backend mengirimkan data (secara default, respons tetap terbuka jika backend memiliki lebih banyak data untuk dikirim). Hal ini untuk menghindari masalah ketidakcocokan dengan proxy tertentu, perangkat lunak antivirus, dll. yang melakukan buffering lalu lintas secara tidak tepat tanpa batas waktu. Penggunaan opsi ini akan menyebabkan penurunan kinerja.
Pengaturan ini tidak dapat digunakan dengan experimentalAutoDetectLongPolling dan mungkin dihapus pada rilis mendatang. Jika Anda menggunakannya untuk mengatasi masalah keandalan jaringan tertentu, beri tahu kami tentang hal itu di https://github.com/firebase/firebase-js-sdk/issues/1674.
Pengaturan ini tidak dapat digunakan di lingkungan Node.js.
Tanda tangan:
experimentalForceLongPolling?: boolean;
FirestoreSettings.experimentalLongPollingOptions
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 jajak pendapat panjang diperlukan. Jika tidak, pilihan ini tidak akan berpengaruh.
Tanda tangan:
experimentalLongPollingOptions?: ExperimentalLongPollingOptions;
FirestoreSettings.host
Nama host yang akan dihubungkan.
Tanda tangan:
host?: string;
FirestoreSettings.ignoreUnfineProperties
Apakah akan melewati properti bertingkat yang disetel ke undefined selama serialisasi objek. Jika disetel ke true , properti ini dilewati dan tidak ditulis ke Firestore. Jika disetel ke false atau dihilangkan, SDK akan mengeluarkan pengecualian saat menemukan properti bertipe 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 berbeda.
Jika tidak ditentukan, MemoryLocalCache akan digunakan secara default.
CATATAN: menyetel bidang ini dan cacheSizeBytes secara bersamaan akan memunculkan pengecualian selama inisialisasi SDK. Sebagai gantinya, gunakan konfigurasi di objek FirestoreLocalCache untuk menentukan ukuran cache.
Tanda tangan:
localCache?: FirestoreLocalCache;
Pengaturan Firestore.ssl
Apakah akan menggunakan SSL saat menghubungkan.
Tanda tangan:
ssl?: boolean;