QuerySnapshot class

QuerySnapshot chứa không hoặc nhiều đối tượng DocumentSnapshot thể hiện kết quả của truy vấn. Các tài liệu có thể được truy cập dưới dạng một mảng thông qua thuộc tính docs hoặc được liệt kê bằng phương thức forEach . Số lượng tài liệu có thể được xác định thông qua các thuộc tính emptysize .

Chữ ký:

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

Của cải

Tài sản sửa đổi Kiểu Sự miêu tả
tài liệu Mảng< QueryDocumentSnapshot <AppModelType, DbModelType>> Một mảng tất cả các tài liệu trong QuerySnapshot .
trống boolean Đúng nếu không có tài liệu nào trong QuerySnapshot .
metadata Siêu dữ liệu ảnh chụp nhanh Siêu dữ liệu về ảnh chụp nhanh này, liên quan đến nguồn của nó và liệu nó có sửa đổi cục bộ hay không.
truy vấn Truy vấn <AppModelType, DbModelType> Truy vấn mà bạn gọi là get hoặc onSnapshot để nhận được QuerySnapshot này.
kích cỡ con số Số lượng tài liệu trong QuerySnapshot .

phương pháp

Phương pháp sửa đổi Sự miêu tả
docChanges(tùy chọn) Trả về một mảng các thay đổi của tài liệu kể từ ảnh chụp nhanh cuối cùng. Nếu đây là ảnh chụp nhanh đầu tiên, tất cả tài liệu sẽ nằm trong danh sách dưới dạng các thay đổi được 'thêm'.
forEach(gọi lại, thisArg) Liệt kê tất cả các tài liệu trong QuerySnapshot .

QuerySnapshot.docs

Một mảng tất cả các tài liệu trong QuerySnapshot .

Chữ ký:

get docs(): Array<QueryDocumentSnapshot<AppModelType, DbModelType>>;

QuerySnapshot.empty

Đúng nếu không có tài liệu nào trong QuerySnapshot .

Chữ ký:

get empty(): boolean;

QuerySnapshot.metadata

Siêu dữ liệu về ảnh chụp nhanh này, liên quan đến nguồn của nó và liệu nó có sửa đổi cục bộ hay không.

Chữ ký:

readonly metadata: SnapshotMetadata;

QuerySnapshot.query

Truy vấn mà bạn gọi get hoặc onSnapshot để có được QuerySnapshot này .

Chữ ký:

readonly query: Query<AppModelType, DbModelType>;

QuerySnapshot.size

Số lượng tài liệu trong QuerySnapshot .

Chữ ký:

get size(): number;

QuerySnapshot.docChanges()

Trả về một mảng các thay đổi của tài liệu kể từ ảnh chụp nhanh cuối cùng. Nếu đây là ảnh chụp nhanh đầu tiên, tất cả tài liệu sẽ nằm trong danh sách dưới dạng các thay đổi được 'thêm'.

Chữ ký:

docChanges(options?: SnapshotListenOptions): Array<DocumentChange<AppModelType, DbModelType>>;

Thông số

Tham số Kiểu Sự miêu tả
tùy chọn Ảnh chụp nhanhNgheTùy chọn SnapshotListenOptions kiểm soát xem các thay đổi chỉ dành cho siêu dữ liệu (tức là chỉ thay đổi DocumentSnapshot.metadata ) có kích hoạt các sự kiện chụp nhanh hay không.

Trả về:

Mảng < Thay đổi tài liệu <AppModelType, DbModelType>>

QuerySnapshot.forEach()

Liệt kê tất cả các tài liệu trong QuerySnapshot .

Chữ ký:

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

Thông số

Tham số Kiểu Sự miêu tả
gọi lại (kết quả: QueryDocumentSnapshot <AppModelType, DbModelType>) => void Lệnh gọi lại sẽ được gọi với QueryDocumentSnapshot cho mỗi tài liệu trong ảnh chụp nhanh.
cái nàyArg không xác định Ràng buộc this cho cuộc gọi lại.

Trả về:

trống rỗng