SnapshotOptions interface

DocumentSnapshotからデータを取得する方法を構成するオプション (たとえば、最終値がまだ設定されていないサーバーのタイムスタンプの望ましい動作など)。

サイン:

export declare interface SnapshotOptions 

プロパティ

財産タイプ説明
サーバータイムスタンプ'見積もり' | '前' | 'なし'設定されている場合、最終値がまだ設定されていないサーバーのタイムスタンプの戻り値を制御します。 「estimate」を指定すると、保留中のサーバーのタイムスタンプはローカル クロックに基づいた推定値を返します。この推定値は最終値とは異なるため、サーバーの結果が利用可能になると、これらの値が変更されます。 「previous」を指定すると、保留中のタイムスタンプは無視され、代わりに以前の値が返されます。省略するか「none」に設定すると、サーバー値が使用可能になるまで、デフォルトでnullが返されます。

SnapshotOptions.serverTimestamps

設定されている場合、最終値がまだ設定されていないサーバーのタイムスタンプの戻り値を制御します。

「estimate」を指定すると、保留中のサーバーのタイムスタンプはローカル クロックに基づいた推定値を返します。この推定値は最終値とは異なるため、サーバーの結果が利用可能になると、これらの値が変更されます。

「previous」を指定すると、保留中のタイムスタンプは無視され、代わりに以前の値が返されます。

省略するか「none」に設定すると、サーバー値が使用可能になるまで、デフォルトでnullが返されます。

サイン:

readonly serverTimestamps?: 'estimate' | 'previous' | 'none';