CollectionReference class

CollectionReference nesnesi, belge eklemek, belge referansları almak ve belgeleri sorgulamak ( query() kullanarak) için kullanılabilir. ).

İmza:

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

Genişletilir: Sorgu <AppModelType, DbModelType>

Özellikler

Mülk Değiştiriciler Tip Tanım
İD sicim Koleksiyonun tanımlayıcısı.
ebeveyn BelgeReferansı < BelgeVerileri , BelgeVerileri > | hükümsüz Bu bir alt koleksiyonsa, onu içeren DocumentReference bir başvuru. Bu bir alt koleksiyon değilse referans boştur.
yol sicim Başvurulan koleksiyonun yolunu temsil eden bir dize (veritabanının köküne göre).
tip (bildirilmedi) Bu Firestore referansının türü.

Yöntemler

Yöntem Değiştiriciler Tanım
Dönüştürücü ile(dönüştürücü) Bu CollectionReference öğesine özel bir veri dönüştürücü uygulayarak Firestore ile kendi özel model nesnelerinizi kullanmanıza olanak tanır. Döndürülen CollectionReference örneğiyle addDoc() öğesini çağırdığınızda, sağlanan dönüştürücü NewDbModelType türündeki Firestore verileri ile NewAppModelType özel türünüz arasında dönüşüm gerçekleştirir.
Dönüştürücü ile(dönüştürücü) Geçerli dönüştürücüyü kaldırır.

KoleksiyonReferans.id

Koleksiyonun tanımlayıcısı.

İmza:

get id(): string;

KoleksiyonReferansı.parent

Bu bir alt koleksiyonsa, onu içeren DocumentReference bir referans. Bu bir alt koleksiyon değilse referans boştur.

İmza:

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

KoleksiyonReferansı.yolu

Başvurulan koleksiyonun yolunu temsil eden bir dize (veritabanının köküne göre).

İmza:

get path(): string;

KoleksiyonReferans.tipi

Bu Firestore referansının türü.

İmza:

readonly type = "collection";

CollectionReference.withConverter()

Bu CollectionReference özel bir veri dönüştürücü uygular Firestore ile kendi özel model nesnelerinizi kullanmanıza olanak tanır. Döndürülen CollectionReference örneğiyle addDoc() öğesini çağırdığınızda, sağlanan dönüştürücü NewDbModelType türündeki Firestore verileri ile NewAppModelType özel türünüz arasında dönüşüm gerçekleştirir. .

İmza:

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

Parametreler

Parametre Tip Tanım
dönüştürücü FirestoreDataConverter <YeniUygulamaModelTürü, YeniDbModelTürü> Nesneleri Firestore'a ve Firestore'dan dönüştürür.

İadeler:

KoleksiyonReferans <YeniUygulamaModelTürü, YeniDbModelTürü>

Sağlanan dönüştürücüyü kullanan bir CollectionReference .

CollectionReference.withConverter()

Geçerli dönüştürücüyü kaldırır.

İmza:

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

Parametreler

Parametre Tip Tanım
dönüştürücü hükümsüz null geçerli dönüştürücüyü kaldırır.

İadeler:

KoleksiyonReferans < BelgeVerileri , BelgeVerileri >

Dönüştürücü kullanmayan bir CollectionReference<DocumentData, DocumentData> .