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. Bạn có thể trích xuất dữ liệu 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 hoạt động truy cập dữ liệu sẽ trả về giá trị "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 một tài liệu.
Chữ ký:
export declare class DocumentSnapshot<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData>
Công ty sản xuất
| Công ty sản xuất | Công cụ sửa đổi | Mô tả |
|---|---|---|
| (hàm khởi tạo)() | Tạo một thực thể mới của lớp DocumentSnapshot |
Thuộc tính
| Tài sản | Công cụ sửa đổi | Loại | Mô tả |
|---|---|---|---|
| id | chuỗi | Thuộc tính của DocumentSnapshot cung cấp mã nhận dạng của tài liệu. |
|
| tham chiếu | DocumentReference<AppModelType, DbModelType> | DocumentReference cho tài liệu trong DocumentSnapshot. |
Phương thức
| Phương thức | Công cụ sửa đổi | Mô 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. |
|
| exists() | Tín hiệu cho biết tài liệu tại vị trí ảnh chụp nhanh có tồn tại hay không. | |
| get(fieldPath) | Truy xuất trường do fieldPath chỉ định. Trả về undefined nếu tài liệu hoặc trường không tồn tại. |
DocumentSnapshot.(hàm khởi tạo)
Tạo một thực thể mới của lớp DocumentSnapshot
Chữ ký:
protected constructor();
DocumentSnapshot.id
Thuộc tính của DocumentSnapshot cung cấp mã nhận dạng của tài liệu.
Chữ ký:
get id(): string;
DocumentSnapshot.ref
DocumentReference cho tài liệu 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ường hợp trả lại hàng:
AppModelType | chưa xác định
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()
Tín hiệu cho biết tài liệu tại vị trí ảnh chụp nhanh có tồn tại hay không.
Chữ ký:
exists(): this is QueryDocumentSnapshot<AppModelType, DbModelType>;
Trường hợp trả lại hàng:
đây là QueryDocumentSnapshot<AppModelType, DbModelType>
true nếu tài liệu tồn tại.
DocumentSnapshot.get()
Truy xuất trường do fieldPath chỉ định. 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ố
| Thông số | Loại | Mô tả |
|---|---|---|
| Đường dẫn trường | chuỗi | FieldPath (Đường dẫn trường) | Đường dẫn (ví dụ: "foo" hoặc "foo.bar") đến một trường cụ thể. |
Trường hợp trả lại hàng:
bất kỳ
Dữ liệu tại vị trí trường được chỉ định hoặc không xác định nếu không có trường nào như vậy trong tài liệu.