QuerySnapshot
에는 쿼리 결과를 나타내는 0개 이상의 DocumentSnapshot
개체가 포함되어 있습니다. 문서는 docs
속성을 통해 배열로 액세스하거나 forEach
메서드를 사용하여 열거할 수 있습니다. 문서 수는 empty
및 size
속성을 통해 결정될 수 있습니다.
서명:
export declare class QuerySnapshot<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData>
속성
재산 | 수정자 | 유형 | 설명 |
---|---|---|---|
문서 | 배열< 쿼리DocumentSnapshot <AppModelType, DbModelType>> | QuerySnapshot 에 있는 모든 문서의 배열입니다. | |
비어 있는 | 부울 | QuerySnapshot 에 문서가 없으면 True입니다. | |
메타데이터 | 스냅샷메타데이터 | 소스 및 로컬 수정 사항이 있는지 여부에 관한 이 스냅샷에 대한 메타데이터입니다. | |
질문 | 질문 <AppModelType, DbModelType> | 이 QuerySnapshot 가져오기 위해 get 또는 onSnapshot 호출한 쿼리입니다. | |
크기 | 숫자 | QuerySnapshot 의 문서 수입니다. |
행동 양식
방법 | 수정자 | 설명 |
---|---|---|
docChanges(옵션) | 마지막 스냅샷 이후 문서 변경 사항의 배열을 반환합니다. 이것이 첫 번째 스냅샷인 경우 '추가' 변경 사항에 따라 모든 문서가 목록에 표시됩니다. | |
forEach(콜백, thisArg) | QuerySnapshot 의 모든 문서를 열거합니다. |
쿼리스냅샷.docs
QuerySnapshot
에 있는 모든 문서의 배열 .
서명:
get docs(): Array<QueryDocumentSnapshot<AppModelType, DbModelType>>;
쿼리스냅샷.비어 있음
QuerySnapshot
에 문서가 없으면 True입니다. .
서명:
get empty(): boolean;
쿼리Snapshot.metadata
소스 및 로컬 수정 사항이 있는지 여부에 관한 이 스냅샷에 대한 메타데이터입니다.
서명:
readonly metadata: SnapshotMetadata;
쿼리Snapshot.query
이 QuerySnapshot
얻기 위해 get
또는 onSnapshot
호출한 쿼리입니다. .
서명:
readonly query: Query<AppModelType, DbModelType>;
쿼리Snapshot.size
QuerySnapshot
의 문서 수 .
서명:
get size(): number;
QuerySnapshot.docChanges()
마지막 스냅샷 이후 문서 변경 사항의 배열을 반환합니다. 이것이 첫 번째 스냅샷인 경우 '추가' 변경 사항에 따라 모든 문서가 목록에 표시됩니다.
서명:
docChanges(options?: SnapshotListenOptions): Array<DocumentChange<AppModelType, DbModelType>>;
매개변수
매개변수 | 유형 | 설명 |
---|---|---|
옵션 | 스냅샷 듣기 옵션 | 메타데이터 전용 변경(즉, DocumentSnapshot.metadata 만 변경됨)이 스냅샷 이벤트를 트리거해야 하는지 여부를 제어하는 SnapshotListenOptions 입니다. |
보고:
배열< DocumentChange <AppModelType, DbModelType>>
쿼리Snapshot.forEach()
QuerySnapshot
의 모든 문서를 열거합니다. .
서명:
forEach(callback: (result: QueryDocumentSnapshot<AppModelType, DbModelType>) => void, thisArg?: unknown): void;
매개변수
매개변수 | 유형 | 설명 |
---|---|---|
콜백 | (결과: QueryDocumentSnapshot <AppModelType, DbModelType>) => 무효 | 스냅샷의 각 문서에 대해 QueryDocumentSnapshot 으로 호출할 콜백입니다. |
thisArg | 알려지지 않은 | 콜백에 대한 바인딩 this . |
보고:
무효의