QuerySnapshot
には、クエリの結果を表す 0 個以上の DocumentSnapshot
オブジェクトが含まれます。ドキュメントには、docs
プロパティを介して配列としてアクセスすることも、forEach
メソッドを使用して列挙することもできます。ドキュメントの数は、empty
プロパティと size
プロパティで確認できます。
署名:
export declare class QuerySnapshot<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData>
プロパティ
プロパティ | 修飾キー | タイプ | 説明 |
---|---|---|---|
ドキュメント | Array<QueryDocumentSnapshot<AppModelType, DbModelType>> | QuerySnapshot 内のすべてのドキュメントの配列。 |
|
なし | ブール値 | QuerySnapshot にドキュメントがない場合は true。 |
|
metadata | SnapshotMetadata | ソースとローカルの変更の有無に関する、このスナップショットに関するメタデータ。 | |
query | Query<AppModelType、DbModelType> | この QuerySnapshot を取得するために get または onSnapshot を呼び出したクエリ。 |
|
size | 数値 | QuerySnapshot 内のドキュメント数。 |
メソッド
メソッド | 修飾キー | 説明 |
---|---|---|
docChanges(オプション) | 最後のスナップショット以降にドキュメントに加えられた変更の配列を返します。これが最初のスナップショットの場合は、すべてのドキュメントが「追加済み」としてリストに表示されます。できます。 | |
forEach(callback, 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>>;
パラメータ
パラメータ | 型 | 説明 |
---|---|---|
オプション | SnapshotListenOptions | SnapshotListenOptions は、メタデータのみの変更(つまり、DocumentSnapshot.metadata の変更のみ)がスナップショット イベントをトリガーするかどうかを制御します。 |
戻り値:
Array<DocumentChange<AppModelType, DbModelType>>
QuerySnapshot.forEach()
QuerySnapshot
内のすべてのドキュメントを列挙します。
署名:
forEach(callback: (result: QueryDocumentSnapshot<AppModelType, DbModelType>) => void, thisArg?: unknown): void;
パラメータ
パラメータ | 型 | 説明 |
---|---|---|
callback | (結果: QueryDocumentSnapshot<AppModelType, DbModelType>) =>無効 | スナップショット内のドキュメントごとに QueryDocumentSnapshot で呼び出されるコールバック。 |
この引数 | 不明 | コールバックの this バインディング。 |
戻り値:
void