QuerySnapshot class

QuerySnapshot มีวัตถุ DocumentSnapshot เป็นศูนย์หรือมากกว่าซึ่งแสดงถึงผลลัพธ์ของการสืบค้น เอกสารสามารถเข้าถึงได้เป็นอาร์เรย์ผ่านคุณสมบัติ docs หรือแจกแจงโดยใช้วิธี forEach สามารถกำหนดจำนวนเอกสารได้โดยใช้คุณสมบัติ empty และ size

ลายเซ็น:

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

คุณสมบัติ

คุณสมบัติ	ตัวดัดแปลง	พิมพ์	คำอธิบาย
เอกสาร		อาร์เรย์ < QueryDocumentSnapshot <AppModelType, DbModelType>>	อาร์เรย์ของเอกสารทั้งหมดใน QuerySnapshot
ว่างเปล่า		บูลีน	เป็นจริงหากไม่มีเอกสารใน QuerySnapshot
ข้อมูลเมตา		SnapshotMetadata	ข้อมูลเมตาเกี่ยวกับสแนปชอตนี้ เกี่ยวกับแหล่งที่มาและมีการแก้ไขในเครื่องหรือไม่
แบบสอบถาม		แบบสอบถาม <AppModelType, DbModelType>	แบบสอบถามที่คุณเรียกว่า get หรือ onSnapshot เพื่อรับ QuerySnapshot นี้
ขนาด		ตัวเลข	จำนวนเอกสารใน QuerySnapshot

วิธีการ

วิธี	ตัวดัดแปลง	คำอธิบาย
docChanges (ตัวเลือก)		ส่งกลับอาร์เรย์ของการเปลี่ยนแปลงเอกสารตั้งแต่สแนปชอตครั้งล่าสุด หากนี่เป็นภาพรวมแรก เอกสารทั้งหมดจะอยู่ในรายการเมื่อมีการเปลี่ยนแปลง "เพิ่ม"
forEach (โทรกลับ, thisArg)		ระบุเอกสารทั้งหมดใน QuerySnapshot

QuerySnapshot.docs

อาร์เรย์ของเอกสารทั้งหมดใน QuerySnapshot .

ลายเซ็น:

get docs(): Array<QueryDocumentSnapshot<AppModelType, DbModelType>>;

QuerySnapshot.empty

เป็นจริงหากไม่มีเอกสารใน QuerySnapshot .

ลายเซ็น:

get empty(): boolean;

QuerySnapshot.metadata

ข้อมูลเมตาเกี่ยวกับสแนปชอตนี้ เกี่ยวกับแหล่งที่มาและมีการแก้ไขในเครื่องหรือไม่

ลายเซ็น:

readonly metadata: SnapshotMetadata;

QuerySnapshot.query

แบบสอบถามที่คุณเรียกว่า get หรือ onSnapshot เพื่อรับ QuerySnapshot นี้ .

ลายเซ็น:

readonly query: Query<AppModelType, DbModelType>;

QuerySnapshot.size

จำนวนเอกสารใน QuerySnapshot .

ลายเซ็น:

get size(): number;

QuerySnapshot.docChanges()

ส่งกลับอาร์เรย์ของการเปลี่ยนแปลงเอกสารตั้งแต่สแนปชอตครั้งล่าสุด หากนี่เป็นภาพรวมแรก เอกสารทั้งหมดจะอยู่ในรายการเมื่อมีการเปลี่ยนแปลง "เพิ่ม"

ลายเซ็น:

docChanges(options?: SnapshotListenOptions): Array<DocumentChange<AppModelType, DbModelType>>;

พารามิเตอร์

พารามิเตอร์	พิมพ์	คำอธิบาย
ตัวเลือก	SnapshotListenOptions	SnapshotListenOptions ที่ควบคุมว่าการเปลี่ยนแปลงเฉพาะข้อมูลเมตา (เช่น เฉพาะ DocumentSnapshot.metadata ที่เปลี่ยนแปลง) ควรทริกเกอร์เหตุการณ์สแน็ปช็อตหรือไม่

ผลตอบแทน:

อาร์เรย์ < การเปลี่ยนแปลงเอกสาร <AppModelType, DbModelType>>

QuerySnapshot.forEach()

ระบุเอกสารทั้งหมดใน QuerySnapshot .

ลายเซ็น:

forEach(callback: (result: QueryDocumentSnapshot<AppModelType, DbModelType>) => void, thisArg?: unknown): void;

พารามิเตอร์

พารามิเตอร์	พิมพ์	คำอธิบาย
โทรกลับ	(ผลลัพธ์: QueryDocumentSnapshot <AppModelType, DbModelType>) => เป็นโมฆะ	การโทรกลับที่จะเรียกด้วย QueryDocumentSnapshot สำหรับแต่ละเอกสารในสแน็ปช็อต
ข้อโต้แย้งนี้	ไม่ทราบ	การเชื่อมโยง this สำหรับการโทรกลับ

ผลตอบแทน:

เป็นโมฆะ