QuerySnapshot
は、クエリの結果を表す 0 個以上のDocumentSnapshot
オブジェクトが含まれます。ドキュメントには、 docs
プロパティを使用して配列としてアクセスすることも、 forEach
メソッドを使用して列挙することもできます。ドキュメントの数は、 empty
プロパティとsize
プロパティによって決定できます。
サイン:
export declare class QuerySnapshot<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData>
プロパティ
財産 | 修飾子 | タイプ | 説明 |
---|---|---|---|
ドキュメント | 配列< QueryDocumentSnapshot <AppModelType、DbModelType>> | QuerySnapshot 内のすべてのドキュメントの配列。 | |
空の | ブール値 | QuerySnapshot にドキュメントがない場合は True。 | |
クエリ | クエリ<AppModelType、DbModelType> | このQuerySnapshot を取得するためにgetDocs()を呼び出したクエリ。 | |
サイズ | 番号 | QuerySnapshot 内のドキュメントの数。 |
メソッド
方法 | 修飾子 | 説明 |
---|---|---|
forEach(コールバック、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;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
折り返し電話 | (結果: QueryDocumentSnapshot <AppModelType, DbModelType>) => void | スナップショット内の各ドキュメントに対してQueryDocumentSnapshot で呼び出されるコールバック。 |
この引数 | 未知 | コールバックのthis バインディング。 |
戻り値:
空所