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 を取得するためにget またはonSnapshot を呼び出したクエリ。 | |
サイズ | 番号 | QuerySnapshot 内のドキュメントの数。 |
メソッド
方法 | 修飾子 | 説明 |
---|---|---|
docChanges(オプション) | 最後のスナップショット以降のドキュメントの変更の配列を返します。これが最初のスナップショットである場合、すべてのドキュメントが「追加された」変更としてリストに表示されます。 | |
forEach(コールバック、thisArg) | QuerySnapshot 内のすべてのドキュメントを列挙します。 |
QuerySnapshot.docs
QuerySnapshot
内のすべてのドキュメントの配列。
サイン:
get docs(): Array<QueryDocumentSnapshot<AppModelType, DbModelType>>;
QuerySnapshot.empty
QuerySnapshot
にドキュメントがない場合は True 。
サイン:
get empty(): boolean;
QuerySnapshot.metadata
このスナップショットに関するメタデータ、そのソースに関するメタデータ、およびローカル変更があるかどうか。
サイン:
readonly metadata: SnapshotMetadata;
QuerySnapshot.query
このQuerySnapshot
を取得するためにget
またはonSnapshot
を呼び出したクエリ。
サイン:
readonly query: Query<AppModelType, DbModelType>;
QuerySnapshot.size
QuerySnapshot
内のドキュメントの数。
サイン:
get size(): number;
QuerySnapshot.docChanges()
最後のスナップショット以降のドキュメントの変更の配列を返します。これが最初のスナップショットである場合、すべてのドキュメントが「追加された」変更としてリストに表示されます。
サイン:
docChanges(options?: SnapshotListenOptions): Array<DocumentChange<AppModelType, DbModelType>>;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
オプション | スナップショットリッスンオプション | メタデータのみの変更 (つまり、 DocumentSnapshot.metadata のみが変更される) がスナップショット イベントをトリガーするかどうかを制御するSnapshotListenOptions 。 |
戻り値:
配列< DocumentChange <AppModelType、DbModelType>>
QuerySnapshot.forEach()
QuerySnapshot
内のすべてのドキュメントを列挙します。 。
サイン:
forEach(callback: (result: QueryDocumentSnapshot<AppModelType, DbModelType>) => void, thisArg?: unknown): void;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
折り返し電話 | (結果: QueryDocumentSnapshot <AppModelType, DbModelType>) => void | スナップショット内の各ドキュメントに対してQueryDocumentSnapshot で呼び出されるコールバック。 |
この引数 | 未知 | コールバックのthis バインディング。 |
戻り値:
空所