QuerySnapshot class

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

簽名:

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

屬性

屬性 修飾符 類型 說明
文件 陣列<QueryDocumentSnapshot<AppModelType, DBMModelType>> QuerySnapshot 中所有文件的陣列。
空白 布林值 如果 QuerySnapshot 中沒有文件,則為「是」。
查詢 查詢<AppModelType、DundModelType> 為取得這個 QuerySnapshot 而呼叫 getDoc() 的查詢。
size [尺寸] 數字 QuerySnapshot 中的文件數量。

方法

方法 修飾符 說明
forEach(回呼, thisArg) 列舉 QuerySnapshot 中的所有文件。

QuerySnapshot.docs

QuerySnapshot 中所有文件的陣列。

簽名:

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

查詢快照空白

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

簽名:

get empty(): boolean;

QuerySnapshot.query

為取得這個 QuerySnapshot 而呼叫 getDoc() 的查詢。

簽名:

readonly query: Query<AppModelType, DbModelType>;

查詢快照大小

QuerySnapshot 中的文件數量。

簽名:

get size(): number;

QuerySnapshot.forEach()

列舉 QuerySnapshot 中的所有文件。

簽名:

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

參數

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

傳回:

void