QuerySnapshot
มีวัตถุ DocumentSnapshot
เป็นศูนย์หรือมากกว่าซึ่งแสดงถึงผลลัพธ์ของการสืบค้น เอกสารสามารถเข้าถึงได้เป็นอาร์เรย์ผ่านคุณสมบัติ docs
หรือแจกแจงโดยใช้วิธี forEach
สามารถกำหนดจำนวนเอกสารได้โดยใช้คุณสมบัติ empty
และ size
ลายเซ็น:
export declare class QuerySnapshot<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData>
คุณสมบัติ
คุณสมบัติ | ตัวดัดแปลง | พิมพ์ | คำอธิบาย |
---|---|---|---|
เอกสาร | อาร์เรย์ < QueryDocumentSnapshot <AppModelType, DbModelType>> | อาร์เรย์ของเอกสารทั้งหมดใน QuerySnapshot | |
ว่างเปล่า | บูลีน | เป็นจริงหากไม่มีเอกสารใน QuerySnapshot | |
แบบสอบถาม | แบบสอบถาม <AppModelType, DbModelType> | แบบสอบถามที่คุณเรียกใช้ getDocs() เพื่อรับ QuerySnapshot นี้ | |
ขนาด | ตัวเลข | จำนวนเอกสารใน QuerySnapshot |
วิธีการ
วิธี | ตัวดัดแปลง | คำอธิบาย |
---|---|---|
forEach (โทรกลับ, thisArg) | ระบุเอกสารทั้งหมดใน QuerySnapshot |
QuerySnapshot.docs
อาร์เรย์ของเอกสารทั้งหมดใน QuerySnapshot
.
ลายเซ็น:
get docs(): Array<QueryDocumentSnapshot<AppModelType, DbModelType>>;
QuerySnapshot.empty
เป็นจริงหากไม่มีเอกสารใน QuerySnapshot
.
ลายเซ็น:
get empty(): boolean;
QuerySnapshot.query
ข้อความค้นหาที่คุณเรียกใช้ getDocs() เพื่อรับ QuerySnapshot
นี้ .
ลายเซ็น:
readonly query: Query<AppModelType, DbModelType>;
QuerySnapshot.size
จำนวนเอกสารใน QuerySnapshot
.
ลายเซ็น:
get size(): number;
QuerySnapshot.forEach()
ระบุเอกสารทั้งหมดใน QuerySnapshot
.
ลายเซ็น:
forEach(callback: (result: QueryDocumentSnapshot<AppModelType, DbModelType>) => void, thisArg?: unknown): void;
พารามิเตอร์
พารามิเตอร์ | พิมพ์ | คำอธิบาย |
---|---|---|
โทรกลับ | (ผลลัพธ์: QueryDocumentSnapshot <AppModelType, DbModelType>) => เป็นโมฆะ | การโทรกลับที่จะเรียกด้วย QueryDocumentSnapshot สำหรับแต่ละเอกสารในสแน็ปช็อต |
ข้อโต้แย้งนี้ | ไม่ทราบ | การเชื่อมโยง this สำหรับการโทรกลับ |
ผลตอบแทน:
เป็นโมฆะ