DocumentSnapshot chứa dữ liệu được đọc từ một tài liệu trong cơ sở dữ liệu Firestore của bạn. Dữ liệu có thể được trích xuất bằng .data() hoặc .get(<field>) để lấy một trường cụ thể.
Đối với DocumentSnapshot trỏ đến một tài liệu không tồn tại, mọi quyền truy cập dữ liệu sẽ trả về 'không xác định'. Bạn có thể sử dụng phương thức exists() để xác minh rõ ràng sự tồn tại của tài liệu.
Chữ ký:
export declare class DocumentSnapshot<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData>
nhà xây dựng
| Người xây dựng | sửa đổi | Sự miêu tả |
|---|---|---|
| (người xây dựng)() | Xây dựng một phiên bản mới của lớp DocumentSnapshot |
Của cải
| Tài sản | sửa đổi | Kiểu | Sự miêu tả |
|---|---|---|---|
| nhận dạng | sợi dây | Thuộc tính của DocumentSnapshot cung cấp ID của tài liệu. | |
| giới thiệu | Tài liệu tham khảo <AppModelType, DbModelType> | DocumentReference cho tài liệu có trong DocumentSnapshot . |
phương pháp
| Phương pháp | sửa đổi | Sự miêu tả |
|---|---|---|
| dữ liệu() | Truy xuất tất cả các trường trong tài liệu dưới dạng Object . Trả về undefined nếu tài liệu không tồn tại. | |
| tồn tại() | Báo hiệu liệu tài liệu tại vị trí của ảnh chụp nhanh có tồn tại hay không. | |
| nhận (fieldPath) | Truy xuất trường được chỉ định bởi fieldPath . Trả về undefined nếu tài liệu hoặc trường không tồn tại. |
DocumentSnapshot.(hàm tạo)
Xây dựng một phiên bản mới của lớp DocumentSnapshot
Chữ ký:
protected constructor();
DocumentSnapshot.id
Thuộc tính của DocumentSnapshot cung cấp ID của tài liệu.
Chữ ký:
get id(): string;
Tài liệuSnapshot.ref
DocumentReference cho tài liệu có trong DocumentSnapshot .
Chữ ký:
get ref(): DocumentReference<AppModelType, DbModelType>;
DocumentSnapshot.data()
Truy xuất tất cả các trường trong tài liệu dưới dạng Object . Trả về undefined nếu tài liệu không tồn tại.
Chữ ký:
data(): AppModelType | undefined;
Trả về:
AppModelType | không xác định
Một Object chứa tất cả các trường trong tài liệu hoặc undefined nếu tài liệu không tồn tại.
DocumentSnapshot.exists()
Báo hiệu liệu tài liệu tại vị trí của ảnh chụp nhanh có tồn tại hay không.
Chữ ký:
exists(): this is QueryDocumentSnapshot<AppModelType, DbModelType>;
Trả về:
đây là QueryDocumentSnapshot <AppModelType, DbModelType>
đúng nếu tài liệu tồn tại.
DocumentSnapshot.get()
Truy xuất trường được chỉ định bởi fieldPath . Trả về undefined nếu tài liệu hoặc trường không tồn tại.
Chữ ký:
get(fieldPath: string | FieldPath): any;
Thông số
| Tham số | Kiểu | Sự miêu tả |
|---|---|---|
| trườngĐường dẫn | chuỗi | Đường dẫn trường | Đường dẫn (ví dụ: 'foo' hoặc 'foo.bar') đến một trường cụ thể. |
Trả về:
bất kì
Dữ liệu tại vị trí trường được chỉ định hoặc không được xác định nếu không có trường như vậy tồn tại trong tài liệu.