QuerySnapshot
มีออบเจ็กต์ DocumentSnapshot
จำนวนศูนย์รายการขึ้นไปที่แสดงผลลัพธ์ของคำค้นหา คุณสามารถเข้าถึงเอกสารเป็นอาร์เรย์ผ่านพร็อพเพอร์ตี้ docs
หรือแจกแจงโดยใช้เมธอด forEach
ดูจํานวนเอกสารได้ผ่านพร็อพเพอร์ตี้ empty
และ size
ลายเซ็น:
export declare class QuerySnapshot<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData>
พร็อพเพอร์ตี้
พร็อพเพอร์ตี้ | คีย์ตัวปรับแต่ง | ประเภท | คำอธิบาย |
---|---|---|---|
เอกสาร | อาร์เรย์<QueryDocumentSnapshot<AppModelType, DbModelType>> | อาร์เรย์ของเอกสารทั้งหมดใน QuerySnapshot |
|
ว่าง | boolean | เป็นจริงหากไม่มีเอกสารใน QuerySnapshot |
|
ข้อมูลเมตา | ข้อมูลเมตา | ข้อมูลเมตาเกี่ยวกับสแนปชอตนี้ รวมถึงแหล่งที่มาและในกรณีที่มีการแก้ไขภายใน | |
คำค้นหา | คำค้นหา<AppModelType, DbModelType> | การค้นหาที่คุณเรียกใช้ get หรือ onSnapshot เพื่อให้ได้ QuerySnapshot นี้ |
|
ขนาด [size] | ตัวเลข | จำนวนเอกสารใน QuerySnapshot |
เมธอด
วิธีการ | คีย์ตัวปรับแต่ง | คำอธิบาย |
---|---|---|
docChanges(ตัวเลือก) | แสดงผลอาร์เรย์ของการเปลี่ยนแปลงเอกสารนับตั้งแต่สแนปชอตล่าสุด ถ้าเป็นสแนปชอตแรก เอกสารทั้งหมดจะอยู่ในรายการเป็น "ที่เพิ่ม" การเปลี่ยนแปลง | |
forแต่ละแคมเปญ(callback, thisArg) | แจกแจงเอกสารทั้งหมดใน QuerySnapshot |
QuerySnapshot.docs
อาร์เรย์ของเอกสารทั้งหมดใน QuerySnapshot
ลายเซ็น:
get docs(): Array<QueryDocumentSnapshot<AppModelType, DbModelType>>;
QuerySnapshot.ช่องว่าง
เป็นจริงหากไม่มีเอกสารใน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 ที่ควบคุมว่าการเปลี่ยนแปลงเฉพาะข้อมูลเมตา (เช่น เปลี่ยนแปลงเฉพาะ DocumentSnapshot.metadata ) ควรเรียกเหตุการณ์สแนปชอตหรือไม่ |
การคืนสินค้า:
อาร์เรย์<DocumentChange<AppModelType, DbModelType>>
QuerySnapshot.forIndividual()
แจกแจงเอกสารทั้งหมดใน QuerySnapshot
ลายเซ็น:
forEach(callback: (result: QueryDocumentSnapshot<AppModelType, DbModelType>) => void, thisArg?: unknown): void;
พารามิเตอร์
พารามิเตอร์ | ประเภท | คำอธิบาย |
---|---|---|
Callback | (ผลลัพธ์: QueryDocumentSnapshot<AppModelType, DbModelType>) => เป็นโมฆะ | Callback ที่จะถูกเรียกด้วย QueryDocumentSnapshot สำหรับเอกสารแต่ละรายการในสแนปชอต |
Arg | ไม่ทราบ | การเชื่อมโยง this สำหรับ Callback |
การคืนสินค้า:
เป็นโมฆะ