DocumentSnapshot มีข้อมูลที่อ่านจากเอกสารในฐานข้อมูล Firestore สามารถแยกข้อมูลด้วย .data() หรือ .get(<field>) เพื่อให้ได้ช่องที่เฉพาะเจาะจง
สำหรับ DocumentSnapshot ที่ชี้ไปยังเอกสารที่ไม่มีอยู่ การเข้าถึงข้อมูลจะคืนค่าเป็น "undefined" คุณสามารถใช้เมธอด exists() เพื่อยืนยันการมีอยู่ของเอกสารอย่างชัดแจ้ง
ลายเซ็น:
export declare class DocumentSnapshot<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData>
ผู้ผลิต
| ผู้ผลิต | คีย์ตัวปรับแต่ง | คำอธิบาย |
|---|---|---|
| (เครื่องมือสร้าง)() | สร้างอินสแตนซ์ใหม่ของคลาส DocumentSnapshot |
พร็อพเพอร์ตี้
| พร็อพเพอร์ตี้ | คีย์ตัวปรับแต่ง | ประเภท | คำอธิบาย |
|---|---|---|---|
| id | สตริง | พร็อพเพอร์ตี้ของ DocumentSnapshot ที่ระบุรหัสของเอกสาร |
|
| ข้อมูลเมตา | ข้อมูลเมตา | ข้อมูลเมตาเกี่ยวกับ DocumentSnapshot รวมถึงข้อมูลเกี่ยวกับแหล่งที่มาและการแก้ไขในเครื่อง |
|
| อ้างอิง | DocumentReference<AppModelType, DbModelType> | DocumentReference สำหรับเอกสารที่รวมอยู่ใน DocumentSnapshot |
เมธอด
| วิธีการ | คีย์ตัวปรับแต่ง | คำอธิบาย |
|---|---|---|
| ข้อมูล(ตัวเลือก) | ดึงข้อมูลช่องทั้งหมดในเอกสารเป็น Object แสดงผล undefined หากไม่มีเอกสารระบบจะแสดงผลค่า serverTimestamp() ที่ยังไม่ได้ตั้งเป็นค่าสุดท้ายเป็น null โดยค่าเริ่มต้น คุณลบล้างค่านี้ได้โดยการส่งออบเจ็กต์ตัวเลือก |
|
| exists() | แสดงผลว่ามีข้อมูลอยู่หรือไม่ จริง หากมีเอกสารอยู่ | |
| get(fieldPath, ตัวเลือก) | เรียกข้อมูลฟิลด์ที่ระบุโดย fieldPath แสดงผล undefined หากไม่มีเอกสารหรือช่องโดยค่าเริ่มต้น ระบบจะแสดงผล serverTimestamp() ที่ยังไม่ได้ตั้งเป็นค่าสุดท้ายเป็น null คุณลบล้างค่านี้ได้โดยการส่งออบเจ็กต์ตัวเลือก |
DocumentSnapshot (เครื่องมือสร้าง)
สร้างอินสแตนซ์ใหม่ของคลาส DocumentSnapshot
ลายเซ็น:
protected constructor();
DocumentSnapshot.id
พร็อพเพอร์ตี้ของ DocumentSnapshot ที่ระบุรหัสของเอกสาร
ลายเซ็น:
get id(): string;
DocumentSnapshot.metadata
ข้อมูลเมตาเกี่ยวกับ DocumentSnapshot รวมถึงข้อมูลเกี่ยวกับแหล่งที่มาและการแก้ไขในอุปกรณ์
ลายเซ็น:
readonly metadata: SnapshotMetadata;
DocumentSnapshot.ref
DocumentReference สำหรับเอกสารที่รวมอยู่ใน DocumentSnapshot
ลายเซ็น:
get ref(): DocumentReference<AppModelType, DbModelType>;
DocumentSnapshot.data()
ดึงข้อมูลช่องทั้งหมดในเอกสารเป็น Object แสดงผล undefined หากไม่มีเอกสาร
โดยค่าเริ่มต้น ระบบจะแสดงผลค่า serverTimestamp() ที่ยังไม่ได้ตั้งเป็นค่าสุดท้ายเป็น null คุณลบล้างค่านี้ได้โดยการส่งออบเจ็กต์ตัวเลือก
ลายเซ็น:
data(options?: SnapshotOptions): AppModelType | undefined;
พารามิเตอร์
| พารามิเตอร์ | ประเภท | คำอธิบาย |
|---|---|---|
| ตัวเลือก | ตัวเลือกสแนปชอต | ออบเจ็กต์ตัวเลือกเพื่อกำหนดค่าวิธีดึงข้อมูลจากสแนปชอต (เช่น ลักษณะการทำงานที่ต้องการสำหรับการประทับเวลาของเซิร์ฟเวอร์ที่ยังไม่ได้กำหนดค่าสุดท้าย) |
การคืนสินค้า:
AppModelType | ไม่ได้กำหนด
Object ที่มีช่องทั้งหมดในเอกสารหรือ undefined หากไม่มีเอกสาร
DocumentSnapshot.exists()
แสดงผลว่ามีข้อมูลอยู่หรือไม่ จริง หากมีเอกสารอยู่
ลายเซ็น:
exists(): this is QueryDocumentSnapshot<AppModelType, DbModelType>;
การคืนสินค้า:
นี่คือ QueryDocumentSnapshot<AppModelType, DbModelType>
DocumentSnapshot.get()
เรียกข้อมูลช่องที่ระบุโดย fieldPath แสดงผล undefined หากไม่มีเอกสารหรือช่อง
โดยค่าเริ่มต้น ระบบจะแสดงผล serverTimestamp() ที่ยังไม่ได้กำหนดค่าสุดท้ายเป็น null คุณลบล้างค่านี้ได้โดยการส่งออบเจ็กต์ตัวเลือก
ลายเซ็น:
get(fieldPath: string | FieldPath, options?: SnapshotOptions): any;
พารามิเตอร์
| พารามิเตอร์ | ประเภท | คำอธิบาย |
|---|---|---|
| FieldPath | สตริง | FieldPath | เส้นทาง (เช่น "foo" หรือ "foo.bar") ไปยังช่องที่เจาะจง |
| ตัวเลือก | ตัวเลือกสแนปชอต | ออบเจ็กต์ตัวเลือกเพื่อกำหนดค่าวิธีดึงข้อมูลช่องจากสแนปชอต (เช่น ลักษณะการทำงานที่ต้องการสำหรับการประทับเวลาของเซิร์ฟเวอร์ที่ยังไม่ได้กำหนดค่าสุดท้าย) |
การคืนสินค้า:
ทั้งหมด
ข้อมูล ณ ตำแหน่งช่องที่ระบุ หรือไม่ระบุ หากไม่มีช่องนั้นในเอกสาร