DocumentSnapshot class

DocumentSnapshot Firestore veritabanınızdaki bir belgeden okunan verileri içerir. Belirli bir alanı elde etmek için veriler .data() veya .get(<field>) ile çıkarılabilir.

Mevcut olmayan bir belgeye işaret eden bir DocumentSnapshot için, herhangi bir veri erişimi 'tanımsız' değerini döndürecektir. Bir belgenin varlığını açıkça doğrulamak için exists() yöntemini kullanabilirsiniz.

İmza:

export declare class DocumentSnapshot<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData> 

İnşaatçılar

Oluşturucu Değiştiriciler Tanım
(yapıcı)() DocumentSnapshot sınıfının yeni bir örneğini oluşturur

Özellikler

Mülk Değiştiriciler Tip Tanım
İD sicim Belgenin kimliğini sağlayan DocumentSnapshot özelliği.
referans BelgeReferansı <AppModelType, DbModelType> DocumentSnapshot yer alan belgenin DocumentReference .

Yöntemler

Yöntem Değiştiriciler Tanım
veri() Belgedeki tüm alanları Object olarak alır. Belge mevcut değilse undefined döndürür.
var() Anlık görüntünün konumunda belgenin mevcut olup olmadığını belirtir.
get(fieldPath) fieldPath tarafından belirtilen alanı alır. Belge veya alan mevcut değilse undefined döndürür.

DocumentSnapshot.(yapıcı)

DocumentSnapshot sınıfının yeni bir örneğini oluşturur

İmza:

protected constructor();

DocumentSnapshot.id

Belgenin kimliğini sağlayan DocumentSnapshot özelliği.

İmza:

get id(): string;

DocumentSnapshot.ref

DocumentSnapshot yer alan belgenin DocumentReference .

İmza:

get ref(): DocumentReference<AppModelType, DbModelType>;

DocumentSnapshot.data()

Belgedeki tüm alanları Object olarak alır . Belge mevcut değilse undefined döndürür.

İmza:

data(): AppModelType | undefined;

İadeler:

AppModelType | Tanımsız

Belgedeki tüm alanları içeren veya belge yoksa undefined bir Object .

DocumentSnapshot.exists()

Anlık görüntünün konumunda belgenin mevcut olup olmadığını belirtir.

İmza:

exists(): this is QueryDocumentSnapshot<AppModelType, DbModelType>;

İadeler:

bu QueryDocumentSnapshot'tır <AppModelType, DbModelType>

belge mevcutsa doğru.

DocumentSnapshot.get()

fieldPath tarafından belirtilen alanı alır . Belge veya alan mevcut değilse undefined döndürür.

İmza:

get(fieldPath: string | FieldPath): any;

Parametreler

Parametre Tip Tanım
alan yolu dize | AlanYolu Belirli bir alanın yolu (örneğin 'foo' veya 'foo.bar').

İadeler:

herhangi

Belirtilen alan konumundaki veriler veya belgede böyle bir alan yoksa tanımsızdır.