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、DundModelType>

方法

方法 修飾符 說明
data(選項) 將文件中的所有欄位擷取為 Object根據預設,尚未設為最終值的 serverTimestamp() 值將傳回 null。您可以傳遞選項物件來覆寫此設定。

QueryDocumentSnapshot.data()

將文件中的所有欄位擷取為 Object

根據預設,尚未設為最終值的 serverTimestamp() 值將傳回 null。您可以傳遞選項物件來覆寫此設定。

簽名:

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

參數

參數 類型 說明
選項 SnapshotOptions 選項物件,可設定從快照擷取資料的方式 (例如,在尚未設為最終值的伺服器時間戳記中指定行為)。

傳回:

AppModelType

包含文件所有欄位的 Object