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. | |
meta veri | Anlık GörüntüMeta Verileri | Kaynağı ve yerel değişiklikleriyle ilgili bilgiler de dahil olmak üzere DocumentSnapshot hakkındaki meta veriler. | |
referans | BelgeReferansı <AppModelType, DbModelType> | DocumentSnapshot yer alan belgenin DocumentReference . |
Yöntemler
Yöntem | Değiştiriciler | Tanım |
---|---|---|
veri(seçenekler) | Belgedeki tüm alanları Object olarak alır. Belge mevcut değilse undefined döndürür. Varsayılan olarak, henüz son değerlerine ayarlanmamış olan serverTimestamp() değerleri null olarak döndürülür. Bir seçenekler nesnesini ileterek bunu geçersiz kılabilirsiniz. | |
var() | Verinin mevcut olup olmadığını döndürür. Belge mevcutsa doğrudur. | |
get(fieldPath, seçenekler) | fieldPath tarafından belirtilen alanı alır. Belge veya alan mevcut değilse undefined döndürür. Varsayılan olarak henüz son değerine ayarlanmamış bir serverTimestamp() null olarak döndürülür. Bir seçenekler nesnesini ileterek bunu geçersiz kılabilirsiniz. |
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.metadata
DocumentSnapshot
ilişkin meta veriler kaynağı ve yerel değişiklikler hakkında bilgiler dahil.
İmza:
readonly metadata: SnapshotMetadata;
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.
Varsayılan olarak, henüz nihai değerlerine ayarlanmamış olan serverTimestamp()
değerleri null
olarak döndürülür. . Bir seçenekler nesnesini ileterek bunu geçersiz kılabilirsiniz.
İmza:
data(options?: SnapshotOptions): AppModelType | undefined;
Parametreler
Parametre | Tip | Tanım |
---|---|---|
seçenekler | Anlık Görüntü Seçenekleri | Verilerin anlık görüntüden nasıl alınacağını yapılandırmak için bir seçenekler nesnesi (örneğin, henüz nihai değerlerine ayarlanmamış sunucu zaman damgaları için istenen davranış). |
İadeler:
AppModelType | Tanımsız
Belgedeki tüm alanları içeren veya belge yoksa undefined
bir Object
.
DocumentSnapshot.exists()
Verinin mevcut olup olmadığını döndürür. Belge mevcutsa doğrudur.
İmza:
exists(): this is QueryDocumentSnapshot<AppModelType, DbModelType>;
İadeler:
bu QueryDocumentSnapshot'tır <AppModelType, DbModelType>
DocumentSnapshot.get()
fieldPath
tarafından belirtilen alanı alır . Belge veya alan mevcut değilse undefined
döndürür.
Varsayılan olarak, henüz son değerine ayarlanmamış bir serverTimestamp()
işlevi null
olarak döndürülür. . Bir seçenekler nesnesini ileterek bunu geçersiz kılabilirsiniz.
İmza:
get(fieldPath: string | FieldPath, options?: SnapshotOptions): any;
Parametreler
Parametre | Tip | Tanım |
---|---|---|
alan yolu | dize | AlanYolu | Belirli bir alanın yolu (örneğin 'foo' veya 'foo.bar'). |
seçenekler | Anlık Görüntü Seçenekleri | Alanın anlık görüntüden nasıl alınacağını yapılandırmak için bir seçenekler nesnesi (örneğin, henüz nihai değerlerine ayarlanmamış sunucu zaman damgaları için istenen davranış). |
İadeler:
herhangi
Belirtilen alan konumundaki veriler veya belgede böyle bir alan yoksa tanımsızdır.