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
。