FirestoreSettings interface

Cloud Firestore インスタンスのカスタム構成を指定します。他のメソッドを呼び出す前に、これらを設定する必要があります。

サイン：

export declare interface FirestoreSettings 

プロパティ

FirestoreSettings.cacheSizeBytes

注: このフィールドは将来のメジャー リリースでは非推奨になる予定です。代わりにcacheフィールドを使用して、キャッシュ サイズやその他のキャッシュ構成を指定します。

ディスク上のデータのおおよそのキャッシュ サイズのしきい値。キャッシュがこのサイズを超えると、Firestore は最近使用されていないデータの削除を開始します。このサイズは、キャッシュがそのサイズ以下にとどまることを保証するものではなく、キャッシュが指定されたサイズを超えた場合にクリーンアップが試行されることのみを保証します。

デフォルト値は 40 MB です。しきい値は少なくとも 1 MB に設定する必要があり、 CACHE_SIZE_UNLIMITEDに設定するとガベージ コレクションを無効にすることができます。

サイン：

cacheSizeBytes?: number;

FirestoreSettings.experimentalAutoDetectLongPolling

ロングポーリングを使用する必要があるかどうかを自動的に検出するように、SDK の基礎となるトランスポート (WebChannel) を構成します。これは、 experimentalForceLongPollingに非常に似ています。ただし、必要な場合にのみロングポーリングを使用します。

2019 年の開始以来、この設定のデフォルト値はfalseでしたが、2023 年 5 月の Firebase JavaScript SDK v9.22.0 では、この設定のデフォルト値がtrueに変更されました。つまり、ロングポーリングの自動検出がデフォルトで有効になるようになりました。無効にするには、この設定をfalseに設定しますそして、GitHub のイシューを開いて、ロングポーリングの自動検出を無効にする動機となった問題を共有してください。

この設定は Node.js 環境では使用できません。

サイン：

experimentalAutoDetectLongPolling?: boolean;

FirestoreSettings.experimentalForceLongPolling

SDK の基盤となるネットワーク トランスポート (WebChannel) にロング ポーリングの使用を強制します。バックエンドからの各応答は、バックエンドがデータを送信した直後に閉じられます (デフォルトでは、バックエンドにさらに送信するデータがある場合に備えて、応答は開いたままになります)。これにより、トラフィックを無期限に誤ってバッファリングする特定のプロキシ、ウイルス対策ソフトウェアなどとの非互換性の問題が回避されます。ただし、このオプションを使用すると、パフォーマンスが多少低下します。

この設定は、 experimentalAutoDetectLongPollingでは使用できず、将来のリリースでは削除される可能性があります。特定のネットワークの信頼性の問題を回避するためにこれを使用していることに気付いた場合は、https://github.com/firebase/firebase-js-sdk/issues/1674 でそれについてお知らせください。

この設定は Node.js 環境では使用できません。

サイン：

experimentalForceLongPolling?: boolean;

FirestoreSettings.experimentalLongPollingOptions

ロングポーリングが使用される場合に、SDK の基礎となるネットワーク トランスポート (WebChannel) を構成するオプション。

これらのオプションは、 experimentalForceLongPollingが true である場合、またはexperimentalAutoDetectLongPolling true で、自動検出によってロングポーリングが必要であると判断された場合にのみ使用されます。それ以外の場合、これらのオプションは効果がありません。

サイン：

experimentalLongPollingOptions?: ExperimentalLongPollingOptions;

FirestoreSettings.host

接続先のホスト名。

サイン：

host?: string;

FirestoreSettings.ignoreUnknownProperties

オブジェクトのシリアル化中にundefinedに設定されたネストされたプロパティをスキップするかどうか。 trueに設定した場合の場合、これらのプロパティはスキップされ、Firestore には書き込まれません。 falseに設定するか省略した場合、SDK はundefinedタイプのプロパティを検出すると例外をスローします。 。

サイン：

ignoreUndefinedProperties?: boolean;

FirestoreSettings.localCache

SDKが使用するキャッシュを指定します。使用可能なオプションは、 MemoryLocalCacheとPersistentLocalCacheです。 、それぞれに異なる構成オプションがあります。

指定しない場合、デフォルトでMemoryLocalCacheが使用されます。

注: このフィールドとcacheSizeBytes同時に設定すると、SDKの初期化中に例外がスローされます。代わりに、 FirestoreLocalCacheオブジェクトの構成を使用してキャッシュ サイズを指定します。

サイン：

localCache?: FirestoreLocalCache;

FirestoreSettings.ssl

接続時にSSLを使用するかどうか。

サイン：

ssl?: boolean;