QuerySnapshot class

QuerySnapshot包含零個或多個表示查詢結果的DocumentSnapshot物件。文件可以透過docs屬性作為數組進行訪問,也可以使用forEach方法進行枚舉。文件的數量可以透過emptysize屬性來決定。

簽名:

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

特性

財產修飾符類型描述
文件數組<查詢文件快照<應用程式模型類型,Db模型類型>> QuerySnapshot中所有文件的陣列。
空的布林值如果QuerySnapshot中沒有文檔,則為 True。
元數據快照元數據有關此快照的元數據,涉及其來源以及是否有本地修改。
詢問詢問<應用程式模型類型,Db模型類型>您呼叫getonSnapshot來取得此QuerySnapshot的查詢。
尺寸數位QuerySnapshot中的文件數量。

方法

方法修飾符描述
文件更改(選項)傳回自上次快照以來文件變更的陣列。如果這是第一個快照,則所有文件都將作為「新增」變更出現在清單中。
forEach(回調,thisArg)列舉QuerySnapshot中的所有文件。

查詢快照.docs

QuerySnapshot中所有文件的陣列

簽名:

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

查詢快照.空

如果QuerySnapshot中沒有文檔,則為 True

簽名:

get empty(): boolean;

查詢快照.元數據

有關此快照的元數據,涉及其來源以及是否有本地修改。

簽名:

readonly metadata: SnapshotMetadata;

查詢快照.query

您呼叫getonSnapshot以獲得此QuerySnapshot的查詢

簽名:

readonly query: Query<AppModelType, DbModelType>;

查詢快照大小

QuerySnapshot中的文件數量

簽名:

get size(): number;

QuerySnapshot.docChanges()

傳回自上次快照以來文件變更的陣列。如果這是第一個快照,則所有文件都將作為「新增」變更出現在清單中。

簽名:

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

參數

範圍類型描述
選項快照監聽選項SnapshotListenOptions控制僅元資料變更(即僅變更DocumentSnapshot.metadata )是否應觸發快照事件。

返回:

數組<文件更改<應用程式模型類型,Db模型類型>>

QuerySnapshot.forEach()

枚舉QuerySnapshot中的所有文檔

簽名:

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

參數

範圍類型描述
打回來(結果:查詢文件快照<AppModelType, DbModelType>) => void對於快照中的每個文檔,使用QueryDocumentSnapshot呼叫回呼。
這個參數未知回呼的this綁定。

返回:

空白