DocumentSnapshot class

DocumentSnapshot มีข้อมูลที่อ่านจากเอกสารในฐานข้อมูล Firestore สามารถแยกข้อมูลด้วย .data() หรือ .get(<field>) เพื่อให้ได้ช่องที่เฉพาะเจาะจง

สำหรับ DocumentSnapshot ที่ชี้ไปยังเอกสารที่ไม่มีอยู่ การเข้าถึงข้อมูลจะส่งกลับค่า "undefined" คุณสามารถใช้เมธอด exists() เพื่อยืนยันการมีอยู่ของเอกสารอย่างชัดแจ้ง

ลายเซ็น:

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

ผู้ผลิต

ผู้ผลิต คีย์ตัวปรับแต่ง คำอธิบาย
(เครื่องมือสร้าง)() สร้างอินสแตนซ์ใหม่ของคลาส DocumentSnapshot

พร็อพเพอร์ตี้

พร็อพเพอร์ตี้ คีย์ตัวปรับแต่ง ประเภท คำอธิบาย
id สตริง พร็อพเพอร์ตี้ของ DocumentSnapshot ที่ระบุรหัสของเอกสาร
อ้างอิง DocumentReference<AppModelType, DbModelType> DocumentReference สำหรับเอกสารที่รวมอยู่ใน DocumentSnapshot

เมธอด

วิธีการ คีย์ตัวปรับแต่ง คำอธิบาย
data() ดึงข้อมูลช่องทั้งหมดในเอกสารเป็น Object แสดงผล undefined หากไม่มีเอกสาร
exists() ส่งสัญญาณว่ามีเอกสารที่ตำแหน่งของสแนปชอตหรือไม่
get(fieldPath) เรียกข้อมูลฟิลด์ที่ระบุโดย fieldPath แสดงผล undefined หากไม่มีเอกสารหรือช่อง

DocumentSnapshot (เครื่องมือสร้าง)

สร้างอินสแตนซ์ใหม่ของคลาส DocumentSnapshot

ลายเซ็น:

protected constructor();

DocumentSnapshot.id

พร็อพเพอร์ตี้ของ DocumentSnapshot ที่ระบุรหัสของเอกสาร

ลายเซ็น:

get id(): string;

DocumentSnapshot.ref

DocumentReference สำหรับเอกสารที่รวมอยู่ใน DocumentSnapshot

ลายเซ็น:

get ref(): DocumentReference<AppModelType, DbModelType>;

DocumentSnapshot.data()

ดึงข้อมูลช่องทั้งหมดในเอกสารเป็น Object แสดงผล undefined หากไม่มีเอกสาร

ลายเซ็น:

data(): AppModelType | undefined;

การคืนสินค้า:

AppModelType | ไม่ได้กำหนด

Object ที่มีช่องทั้งหมดในเอกสารหรือ undefined หากไม่มีเอกสาร

DocumentSnapshot.exists()

ส่งสัญญาณว่ามีเอกสารที่ตำแหน่งของสแนปชอตหรือไม่

ลายเซ็น:

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

การคืนสินค้า:

นี่คือ QueryDocumentSnapshot<AppModelType, DbModelType>

true ถ้ามีเอกสารอยู่

DocumentSnapshot.get()

เรียกข้อมูลช่องที่ระบุโดย fieldPath แสดงผล undefined หากไม่มีเอกสารหรือช่อง

ลายเซ็น:

get(fieldPath: string | FieldPath): any;

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
FieldPath สตริง | FieldPath เส้นทาง (เช่น "foo" หรือ "foo.bar") ไปยังช่องที่เจาะจง

การคืนสินค้า:

ทั้งหมด

ข้อมูล ณ ตำแหน่งช่องที่ระบุ หรือไม่ระบุ หากไม่มีช่องนั้นในเอกสาร