DocumentSnapshot class

DocumentSnapshot มีข้อมูลที่อ่านจากเอกสารในฐานข้อมูล Firestore ของคุณ สามารถดึงข้อมูลด้วย .data() หรือ .get(<field>) เพื่อรับฟิลด์เฉพาะ

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

ลายเซ็น:

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

คอนสตรัคเตอร์

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

คุณสมบัติ

คุณสมบัติ	ตัวดัดแปลง	พิมพ์	คำอธิบาย
รหัส		เชือก	คุณสมบัติของ DocumentSnapshot ที่ให้ ID ของเอกสาร
อ้างอิง		เอกสารอ้างอิง <AppModelType, DbModelType>	DocumentReference สำหรับเอกสารที่รวมอยู่ใน DocumentSnapshot

วิธีการ

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

DocumentSnapshot.(ตัวสร้าง)

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

ลายเซ็น:

protected constructor();

เอกสาร Snapshot.id

คุณสมบัติของ DocumentSnapshot ที่ให้ ID ของเอกสาร

ลายเซ็น:

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>

จริงหากมีเอกสารอยู่

DocumentSnapshot.get()

ดึงข้อมูลฟิลด์ที่ระบุโดย fieldPath . ส่งคืน undefined หากไม่มีเอกสารหรือฟิลด์

ลายเซ็น:

get(fieldPath: string | FieldPath): any;

พารามิเตอร์

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

ผลตอบแทน:

ใดๆ

ข้อมูลในตำแหน่งฟิลด์ที่ระบุหรือไม่ได้กำหนดหากไม่มีฟิลด์ดังกล่าวอยู่ในเอกสาร