QuerySnapshot class

QuerySnapshot 包含零或多個 DocumentSnapshot 物件，代表查詢結果。您可以透過 docs 屬性，將文件做為陣列存取，或使用 forEach 方法列舉。文件數量可透過 empty 和 size 屬性決定。

簽名：

export declare class QuerySnapshot<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData>

屬性

屬性 修飾符 類型 說明
文件 陣列<QueryDocumentSnapshot<AppModelType, DBMModelType>> QuerySnapshot 中所有文件的陣列。
空白 布林值 如果 QuerySnapshot 中沒有文件，則為「是」。
中繼資料 SnapshotMetadata 這個快照的相關中繼資料，與快照的來源及本機修改內容相關。
查詢 查詢<AppModelType、DundModelType> 為了取得這個 QuerySnapshot，您呼叫了 get 或 onSnapshot 的查詢。
size [尺寸] 數字 QuerySnapshot 中的文件數量。

方法

方法 修飾符 說明
docChanges(選項) 傳回文件自上次快照以來的變更。如果這是第一個快照，清單中所有文件都會顯示為「已新增」並輸入變更內容
forEach(回呼, thisArg) 列舉 QuerySnapshot 中的所有文件。

QuerySnapshot.docs

QuerySnapshot 中所有文件的陣列。

簽名：

get docs(): Array<QueryDocumentSnapshot<AppModelType, DbModelType>>;

查詢快照空白

如果 QuerySnapshot 中沒有文件，則為「是」。

簽名：

get empty(): boolean;

查詢快照中繼資料

這個快照的相關中繼資料，與快照的來源及本機修改內容相關。

簽名：

readonly metadata: SnapshotMetadata;

QuerySnapshot.query

為了取得這個 QuerySnapshot，您呼叫了 get 或 onSnapshot 的查詢。

簽名：

readonly query: Query<AppModelType, DbModelType>;

查詢快照大小

QuerySnapshot 中的文件數量。

簽名：

get size(): number;

QuerySnapshot.docChanges()

傳回文件自上次快照以來的變更。如果這是第一個快照，清單中所有文件都會顯示為「已新增」並輸入變更內容

簽名：

docChanges(options?: SnapshotListenOptions): Array<DocumentChange<AppModelType, DbModelType>>;

參數

參數 類型 說明
選項 SnapshotListenOptions SnapshotListenOptions 用於控制是否只有中繼資料的變更 (即僅變更 DocumentSnapshot.metadata) 會觸發快照事件。

傳回：

陣列<DocumentChange<AppModelType, DBMModelType>>

QuerySnapshot.forEach()

列舉 QuerySnapshot 中的所有文件。

簽名：

forEach(callback: (result: QueryDocumentSnapshot<AppModelType, DbModelType>) => void, thisArg?: unknown): void;

參數

參數 類型 說明
回呼 (結果：QueryDocumentSnapshot<AppModelType, DBMModelType>) =>void 為快照中的每個文件使用 QueryDocumentSnapshot 呼叫的回呼。
The Arg 不明 回呼的 this 繫結。

傳回：

void