DocumentSnapshot class

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.
siêu dữ liệu SnapSiêu dữ liệu Siêu dữ liệu về DocumentSnapshot, bao gồm thông tin về nguồn và các bản sửa đổi cục bộ.
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(tuỳ chọn) 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.Theo mặc định, các giá trị serverTimestamp() chưa được đặt thành giá trị cuối cùng sẽ được trả về dưới dạng null. Bạn có thể ghi đè giá trị này bằng cách truyền một đối tượng tuỳ chọn.
exists() Trả về trạng thái dữ liệu có tồn tại hay không. Đúng nếu tài liệu tồn tại.
get(fieldPath, options) Truy xuất trường do fieldPath chỉ định. Trả về undefined nếu tài liệu hoặc trường này không tồn tại.Theo mặc định, serverTimestamp() chưa được đặt thành giá trị cuối cùng sẽ được trả về dưới dạng null. Bạn có thể ghi đè giá trị này bằng cách truyền một đối tượng tuỳ chọn.

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.metadata

Siêu dữ liệu về DocumentSnapshot, bao gồm thông tin về nguồn và các bản sửa đổi cục bộ.

Chữ ký:

readonly metadata: SnapshotMetadata;

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.

Theo mặc định, các giá trị serverTimestamp() chưa được đặt thành giá trị cuối cùng sẽ được trả về là null. Bạn có thể ghi đè giá trị này bằng cách truyền một đối tượng tuỳ chọn.

Chữ ký:

data(options?: SnapshotOptions): AppModelType | undefined;

Thông số

Thông số Loại Mô tả
tuỳ chọn Tuỳ chọn ảnh chụp nhanh Một đối tượng tuỳ chọn để định cấu hình cách truy xuất dữ liệu qua bản tổng quan nhanh (ví dụ: hành vi mong muốn đối với dấu thời gian của máy chủ chưa được đặt thành giá trị cuối cùng).

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()

Trả về trạng thái dữ liệu có tồn tại hay không. Đúng nếu tài liệu tồn tại.

Chữ ký:

exists(): this is QueryDocumentSnapshot<AppModelType, DbModelType>;

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

đây là QueryDocumentSnapshot<AppModelType, DbModelType>

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.

Theo mặc định, serverTimestamp() chưa được đặt thành giá trị cuối cùng sẽ được trả về là null. Bạn có thể ghi đè giá trị này bằng cách truyền một đối tượng tuỳ chọn.

Chữ ký:

get(fieldPath: string | FieldPath, options?: SnapshotOptions): 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ể.
tuỳ chọn Tuỳ chọn ảnh chụp nhanh Một đối tượng tuỳ chọn để định cấu hình cách truy xuất trường từ bản tổng quan nhanh (ví dụ: hành vi mong muốn đối với dấu thời gian của máy chủ chưa được đặt thành giá trị cuối cùng).

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.