QuerySnapshot class

QuerySnapshot chứa không hoặc nhiều đối tượng DocumentSnapshot đại diện cho kết quả của một truy vấn. Bạn có thể truy cập các tài liệu 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 empty và size.

Chữ ký:

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

Thuộc tính

Tài sản Công cụ sửa đổi Loại Mô tả
tài liệu Mảng<QueryDocumentSnapshot<AppModelType, DbModelType>> Một mảng chứa tất cả tài liệu trong QuerySnapshot.
trống boolean Đúng nếu không có tài liệu nào trong QuerySnapshot.
siêu dữ liệu SnapSiêu dữ liệu Siêu dữ liệu về ảnh chụp nhanh này, liên quan đến nguồn và liệu nó có sửa đổi cục bộ hay không.
cụm từ tìm kiếm Truy vấn<AppModelType, DbModelType> Truy vấn mà bạn đã gọi get hoặc onSnapshot để nhận QuerySnapshot này.
kích thước số Số tài liệu trong QuerySnapshot.

Phương thức

Phương thức Công cụ sửa đổi Mô tả
docChanges(tuỳ chọn) Trả về một mảng các thay đổi về tài liệu kể từ bản tổng quan nhanh gần đây nhất. Nếu đây là ảnh chụp nhanh đầu tiên, thì tất cả tài liệu sẽ nằm trong danh sách dưới dạng "đã thêm" thay đổi.
forEach(callback, thisArg) Liệt kê tất cả tài liệu trong QuerySnapshot.

QuerySnapshot.docs

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

Chữ ký:

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

Truy vấnSnapshot.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 và liệu nó có sửa đổi cục bộ hay không.

Chữ ký:

readonly metadata: SnapshotMetadata;

Truy vấnSnapshot.query

Truy vấn mà bạn đã gọi get hoặc onSnapshot để nhận QuerySnapshot này.

Chữ ký:

readonly query: Query<AppModelType, DbModelType>;

QuerySnapshot.size

Số tài liệu trong QuerySnapshot.

Chữ ký:

get size(): number;

QuerySnapshot.docChanges()

Trả về một mảng các thay đổi về tài liệu kể từ bản tổng quan nhanh gần đây nhất. Nếu đây là ảnh chụp nhanh đầu tiên, thì tất cả tài liệu sẽ nằm trong danh sách dưới dạng "đã thêm" thay đổi.

Chữ ký:

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

Thông số

Thông số Loại Mô tả
tuỳ chọn SnapshotListenOptions SnapshotListenOptions kiểm soát việc các thay đổi chỉ dành cho siêu dữ liệu (tức là chỉ có DocumentSnapshot.metadata thay đổi) có kích hoạt các sự kiện tổng quan nhanh hay không.

Trường hợp trả lại hàng:

Mảng<DocumentChange<AppModelType, DbModelType>>

QuerySnapshot.forEach()

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

Chữ ký:

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

Thông số

Thông số Loại Mô tả
số gọi lại (kết quả: QueryDocumentSnapshot<AppModelType, DbModelType>) => trống Lệnh gọi lại sẽ được gọi bằng QueryDocumentSnapshot cho mỗi tài liệu trong ảnh chụp nhanh.
nàyArg không xác định Liên kết this cho lệnh gọi lại.

Trường hợp trả lại hàng:

trống