QueryDocumentSnapshot class

QueryDocumentSnapshotには、クエリの一部として Firestore データベース内のドキュメントから読み取られたデータが含まれています。ドキュメントは存在することが保証されており、そのデータを.data()または.get(<field>)で抽出して特定のフィールドを取得できます。

QueryDocumentSnapshotは、 DocumentSnapshotと同じ API サーフェスを提供します。 。クエリ結果には既存のドキュメントのみが含まれるため、 existsプロパティは常に true になり、 data()は '未定義' を返すことはありません。

サイン：

export declare class QueryDocumentSnapshot<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData> extends DocumentSnapshot<AppModelType, DbModelType>

拡張: DocumentSnapshot <AppModelType、DbModelType>

メソッド

方法修飾子説明
データ(オプション)ドキュメント内のすべてのフィールドをObjectとして取得します。デフォルトでは、まだ最終値に設定されていないserverTimestamp()値はnullとして返されます。オプション オブジェクトを渡すことでこれをオーバーライドできます。

QueryDocumentSnapshot.data()

ドキュメント内のすべてのフィールドをObjectとして取得します。 。

デフォルトでは、まだ最終値に設定されていないserverTimestamp()値はnullとして返されます。 。オプション オブジェクトを渡すことでこれをオーバーライドできます。

サイン：

/** @override */
data(options?: SnapshotOptions): AppModelType;

パラメーター

パラメータタイプ説明
オプションスナップショットオプションスナップショットからデータを取得する方法を構成するオプション オブジェクト (たとえば、最終値がまだ設定されていないサーバーのタイムスタンプの望ましい動作など)。

戻り値：

AppModelType

ドキュメント内のすべてのフィールドを含むObject 。