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(options) | ドキュメント内のすべてのフィールドを Object として取得します。デフォルトでは、最終的な値に設定されていない serverTimestamp() 値は null として返されます。これをオーバーライドするには、オプション オブジェクトを渡します。 |
QueryDocumentSnapshot.data()
ドキュメント内のすべてのフィールドを Object として取得します。
デフォルトでは、最終的な値に設定されていない serverTimestamp() 値は null として返されます。これをオーバーライドするには、オプション オブジェクトを渡します。
署名:
/** @override */
data(options?: SnapshotOptions): AppModelType;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| オプション | SnapshotOptions | スナップショットからデータを取得する方法（最終的な値にまだ設定されていないサーバーのタイムスタンプに対する望ましい動作など）を構成するオプション オブジェクト。 |
戻り値:
AppModelType
ドキュメント内のすべてのフィールドを含む Object。