QuerySnapshot class

QuerySnapshot에는 쿼리 결과를 나타내는 DocumentSnapshot 객체가 0개 이상 포함됩니다. 문서는 docs 속성을 통해 배열로 액세스하거나 forEach 메서드를 사용하여 열거할 수 있습니다. 문서 수는 empty 및 size 속성을 통해 결정할 수 있습니다.

서명:

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

속성

속성 특수키 유형 설명
문서 배열<QueryDocumentSnapshot<AppModelType, DBMModelType>> QuerySnapshot에 있는 모든 문서의 배열.
비어 있음 부울 QuerySnapshot에 문서가 없으면 true입니다.
메타데이터 SnapshotMetadata 소스 및 로컬 수정 여부에 관한 이 스냅샷에 대한 메타데이터입니다.
query 쿼리<AppModelType, DBMModelType> 이 QuerySnapshot를 가져오기 위해 get 또는 onSnapshot를 호출한 쿼리입니다.
size 숫자 QuerySnapshot의 문서 수입니다.

메소드

메서드 특수키 설명
docChanges(options) 마지막 스냅샷 이후의 문서 변경사항 배열을 반환합니다. 첫 번째 스냅샷인 경우 모든 문서가 '추가됨'으로 목록에 표시됩니다. 있습니다.
for each(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 메타데이터 전용 변경사항 (즉, DocumentSnapshot.metadata만 변경됨)이 스냅샷 이벤트를 트리거해야 하는지 여부를 제어하는 SnapshotListenOptions

반환:

배열<DocumentChange<AppModelType, DBMModelType>>

QuerySnapshot.forIndividual()

QuerySnapshot의 모든 문서를 열거합니다.

서명:

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

매개변수

매개변수 유형 설명
콜백 (결과: QueryDocumentSnapshot<AppModelType, DBMModelType>) => 무효 스냅샷의 각 문서에 관해 QueryDocumentSnapshot로 호출할 콜백입니다.
thisArg 알 수 없음 콜백의 this 결합입니다.

반환:

void