CollectionReference class

ออบเจ็กต์ CollectionReference สามารถใช้สำหรับการเพิ่มเอกสาร รับการอ้างอิงเอกสาร และค้นหาเอกสาร (โดยใช้ query())

ลายเซ็น:

export declare class CollectionReference<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData> extends Query<AppModelType, DbModelType> 

ขยาย: คำค้นหา<AppModelType, DbModelType>

พร็อพเพอร์ตี้

พร็อพเพอร์ตี้ คีย์ตัวปรับแต่ง ประเภท คำอธิบาย
id สตริง ตัวระบุของคอลเล็กชัน
หลัก DocumentReference<DocumentData, DocumentData> | ค่าว่าง การอ้างอิงไปยัง DocumentReference ที่มี หากเป็นคอลเล็กชันย่อย หากนี่ไม่ใช่คอลเล็กชันย่อย ข้อมูลอ้างอิงจะเป็นค่าว่าง
เส้นทาง สตริง สตริงที่แสดงเส้นทางของคอลเล็กชันที่อ้างอิง (สัมพันธ์กับรูทของฐานข้อมูล)
ประเภท (ไม่ได้ประกาศ) ประเภทของการอ้างอิง Firestore นี้

เมธอด

วิธีการ คีย์ตัวปรับแต่ง คำอธิบาย
withConverter(ตัวแปลง) ใช้เครื่องมือแปลงข้อมูลที่กำหนดเองกับ CollectionReference นี้ ซึ่งจะช่วยให้คุณใช้ออบเจ็กต์โมเดลที่กำหนดเองกับ Firestore ได้ เมื่อคุณเรียกใช้ addDoc() ด้วยอินสแตนซ์ CollectionReference ที่แสดงผล ตัวแปลงที่มีให้จะแปลงระหว่างข้อมูล Firestore ประเภท NewDbModelType และประเภทที่กำหนดเอง NewAppModelType
withConverter(ตัวแปลง) นำตัวแปลงปัจจุบันออก

CollectionReference.id

ตัวระบุของคอลเล็กชัน

ลายเซ็น:

get id(): string;

CollectionReference.parent

การอ้างอิงไปยัง DocumentReference ที่มี หากเป็นคอลเล็กชันย่อย หากนี่ไม่ใช่คอลเล็กชันย่อย ข้อมูลอ้างอิงจะเป็นค่าว่าง

ลายเซ็น:

get parent(): DocumentReference<DocumentData, DocumentData> | null;

CollectionReference.path

สตริงที่แสดงเส้นทางของคอลเล็กชันที่อ้างอิง (สัมพันธ์กับรูทของฐานข้อมูล)

ลายเซ็น:

get path(): string;

CollectionReference.type

ประเภทของการอ้างอิง Firestore นี้

ลายเซ็น:

readonly type = "collection";

CollectionReference.withConverter()

ใช้เครื่องมือแปลงข้อมูลที่กำหนดเองกับ CollectionReference นี้ ซึ่งจะช่วยให้คุณใช้ออบเจ็กต์โมเดลที่กำหนดเองกับ Firestore ได้ เมื่อคุณเรียกใช้ addDoc() ด้วยอินสแตนซ์ CollectionReference ที่แสดงผล ตัวแปลงที่มีให้จะแปลงระหว่างข้อมูล Firestore ประเภท NewDbModelType และประเภทที่กำหนดเอง NewAppModelType

ลายเซ็น:

withConverter<NewAppModelType, NewDbModelType extends DocumentData = DocumentData>(converter: FirestoreDataConverter<NewAppModelType, NewDbModelType>): CollectionReference<NewAppModelType, NewDbModelType>;

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
ผู้ทำ Conversion FirestoreDataConverter<NewAppModelType, NewDbModelType> แปลงออบเจ็กต์เป็นและจาก Firestore

การคืนสินค้า:

CollectionReference<NewAppModelType, NewDbModelType>

CollectionReference ที่ใช้ตัวแปลงที่ระบุ

CollectionReference.withConverter()

นำตัวแปลงปัจจุบันออก

ลายเซ็น:

withConverter(converter: null): CollectionReference<DocumentData, DocumentData>;

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
ผู้ทำ Conversion Null null นำตัวแปลงปัจจุบันออก

การคืนสินค้า:

CollectionReference<DocumentData, DocumentData>

CollectionReference<DocumentData, DocumentData> ที่ไม่ได้ใช้ตัวแปลง