QuerySnapshot class

QuerySnapshot には、クエリの結果を表す 0 個以上の DocumentSnapshot オブジェクトが含まれます。ドキュメントには、docs プロパティを介して配列としてアクセスすることも、forEach メソッドを使用して列挙することもできます。ドキュメントの数は、empty プロパティと size プロパティで確認できます。

署名:

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

プロパティ

プロパティ	修飾キー	タイプ	説明
ドキュメント		Array<QueryDocumentSnapshot<AppModelType, DbModelType>>	QuerySnapshot 内のすべてのドキュメントの配列。
なし		ブール値	QuerySnapshot にドキュメントがない場合は true。
query		Query<AppModelType、DbModelType>	この QuerySnapshot を取得するために getDocs() を呼び出したクエリ。
size		数値	QuerySnapshot 内のドキュメント数。

メソッド

メソッド	修飾キー	説明
forEach(callback, thisArg)		QuerySnapshot 内のすべてのドキュメントを列挙します。

QuerySnapshot.docs

QuerySnapshot 内のすべてのドキュメントの配列。

署名:

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

QuerySnapshot.empty

QuerySnapshot にドキュメントがない場合は true。

署名:

get empty(): boolean;

QuerySnapshot.query

この QuerySnapshot を取得するために getDocs() を呼び出したクエリ。

署名:

readonly query: Query<AppModelType, DbModelType>;

QuerySnapshot.size

QuerySnapshot 内のドキュメント数。

署名:

get size(): number;

QuerySnapshot.forEach()

QuerySnapshot 内のすべてのドキュメントを列挙します。

署名:

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

パラメータ

パラメータ	型	説明
callback	（結果: QueryDocumentSnapshot<AppModelType, DbModelType>) =>無効	スナップショット内のドキュメントごとに QueryDocumentSnapshot で呼び出されるコールバック。
この引数	不明	コールバックの this バインディング。

戻り値:

void