CollectionReference class

ניתן להשתמש באובייקט CollectionReference להוספת מסמכים, קבלת הפניות למסמכים ושאילתה למסמכים (באמצעות query() ).

חֲתִימָה:

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

מרחיב: שאילתה <AppModelType, DbModelType>

נכסים

שיטות

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>;

פרמטרים

החזרות:

הפניה לאוסף <NewAppModelType, NewDbModelType>

CollectionReference שמשתמש בממיר שסופק.

CollectionReference.withConverter()

מסיר את הממיר הנוכחי.

חֲתִימָה:

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

פרמטרים

החזרות:

הפניה לאוסף < DocumentData , DocumentData >

CollectionReference<DocumentData, DocumentData> שאינו משתמש בממיר.