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>
メソッド
メソッド | 修飾キー | 説明 |
---|---|---|
data() | ドキュメント内のすべてのフィールドを Object として取得します。 |
QueryDocumentSnapshot.data()
ドキュメント内のすべてのフィールドを Object
として取得します。
署名:
/** @override */
data(): AppModelType;
戻り値:
AppModelType
ドキュメント内のすべてのフィールドを含む Object
。