QuerySnapshot class

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

サイン：

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

プロパティ

メソッド

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>>;

パラメーター

戻り値：

配列< DocumentChange <AppModelType、DbModelType>>

QuerySnapshot.forEach()

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

サイン：

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

パラメーター

戻り値：

空所