DataSnapshot
bir Veritabanı konumundan veri içerir.
Veritabanından veri okuduğunuzda, verileri Veri DataSnapshot
olarak alırsınız . on()
veya once()
ile eklediğiniz olay geri çağrılarına bir DataSnapshot
iletilir . Anlık görüntünün içeriğini val()
yöntemini çağırarak bir JavaScript nesnesi olarak çıkarabilirsiniz. Alternatif olarak, alt anlık görüntüleri döndürmek için child()
öğesini çağırarak anlık görüntüye geçiş yapabilirsiniz (buna daha sonra val()
adını verebilirsiniz).
DataSnapshot
bir Veritabanı konumundaki verilerin verimli bir şekilde oluşturulmuş, değişmez bir kopyasıdır. Değiştirilemez ve hiçbir zaman değişmeyecektir (verileri değiştirmek için her zaman set()
yöntemini doğrudan bir Reference
çağırırsınız).
İmza:
export declare class DataSnapshot
Özellikler
Mülk | Değiştiriciler | Tip | Tanım |
---|---|---|---|
anahtar | dize | hükümsüz | Bu DataSnapshot konumunun anahtarı (yolun son kısmı). Bir Veritabanı konumundaki son belirteç, onun anahtarı olarak kabul edilir. Örneğin, "ada" /users/ada/ düğümünün anahtarıdır. Herhangi bir DataSnapshot anahtara erişildiğinde, onu oluşturan konumun anahtarı döndürülür. Ancak, bir Veritabanının kök URL'sindeki anahtara erişim null sonucunu döndürür. | |
öncelik | dize | sayı | hükümsüz | Bu DataSnapshot içindeki verilerin öncelik değerini alır. Uygulamaların öncelik kullanmasına gerek yoktur ancak koleksiyonları sıradan özelliklere göre sıralayabilir (bkz. Verileri sıralama ve filtreleme ). | |
referans | Veritabanı Referansı | Bu DataSnapshot'ın konumu. | |
boyut | sayı | Bu DataSnapshot öğesinin alt özelliklerinin sayısını döndürür. |
Yöntemler
Yöntem | Değiştiriciler | Tanım |
---|---|---|
çocuk(yol) | Belirtilen göreli yoldaki konum için başka bir DataSnapshot alır. Bir DataSnapshot'ın child() yöntemine göreli bir yol iletmek, belirtilen göreli yoldaki konum için başka bir DataSnapshot döndürür. Göreli yol, basit bir alt ad (örneğin, "ada") veya daha derin, eğik çizgiyle ayrılmış bir yol (örneğin, "ada/ad/ilk") olabilir. Alt konumun verisi yoksa boş bir DataSnapshot (yani değeri null olan bir DataSnapshot ) döndürülür. | |
var() | Bu DataSnapshot herhangi bir veri içeriyorsa true değerini döndürür. snapshot.val() !== null kullanmaktan biraz daha verimlidir. | |
ihracatVal() | DataSnapshot'ın tüm içeriğini bir JavaScript nesnesi olarak dışa aktarır. exportVal() yöntemi, val() yöntemine benzer ancak öncelik bilgilerinin (varsa) dahil edilmesi, verilerinizin yedeklenmesi için uygun olmasını sağlar. | |
forEach(eylem) | IteratedDataSnapshot en üst düzey alt öğeleri numaralandırır. JavaScript nesnelerinin çalışma şekli nedeniyle, val() tarafından döndürülen JavaScript nesnesindeki verilerin sıralamasının sunucudaki sıralamayla veya onChildAdded() olaylarının sıralamasıyla eşleşeceği garanti edilmez. forEach() ın kullanışlı olduğu yer burasıdır. Bir DataSnapshot alt öğelerinin sorgu sıralarında yineleneceğini garanti eder. Açık orderBy*() yöntemi kullanılmazsa, sonuçlar anahtara göre sıralı olarak döndürülür (öncelikler kullanılmadığı sürece, bu durumda sonuçlar önceliğe göre döndürülür). | |
hasChild(yol) | Belirtilen alt yolun (boş olmayan) verileri varsa true değerini döndürür. | |
Çocuk sahibi() | DataSnapshot null olmayan alt özelliklerine sahip olup olmadığını döndürür. DataSnapshot herhangi bir alt öğesi olup olmadığını belirlemek için hasChildren() işlevini kullanabilirsiniz. Eğer öyleyse, bunları forEach() kullanarak numaralandırabilirsiniz. Eğer yoksa, bu anlık görüntü ya ilkel bir değer içerir (bu değer val() ile alınabilir) ya da boştur (bu durumda val() null değerini döndürür). | |
JSON()'a | Bu nesnenin JSON ile seri hale getirilebilir gösterimini döndürür. | |
val() | DataSnapshot bir JavaScript değeri çıkarır. DataSnapshot verilere bağlı olarak val() yöntemi, bir skaler tür (dize, sayı veya boolean), bir dizi veya bir nesne döndürebilir. Ayrıca DataSnapshot boş olduğunu (veri içermediğini) belirterek null değerini döndürebilir. |
DataSnapshot.key
Bu DataSnapshot
konumunun anahtarı (yolun son kısmı) .
Bir Veritabanı konumundaki son belirteç, onun anahtarı olarak kabul edilir. Örneğin, "ada" /users/ada/ düğümünün anahtarıdır. Herhangi bir DataSnapshot
anahtara erişildiğinde, onu oluşturan konumun anahtarı döndürülür. Ancak, bir Veritabanının kök URL'sindeki anahtara erişim null
döndürecektir .
İmza:
get key(): string | null;
DataSnapshot.priority
Bu DataSnapshot
verilerin öncelik değerini alır .
Uygulamaların öncelik kullanmasına gerek yoktur ancak koleksiyonları sıradan özelliklere göre sıralayabilir (bkz. Verileri sıralama ve filtreleme ).
İmza:
get priority(): string | number | null;
DataSnapshot.ref
Bu DataSnapshot'ın konumu.
İmza:
readonly ref: DatabaseReference;
DataSnapshot.size
Bu DataSnapshot
alt özelliklerinin sayısını döndürür .
İmza:
get size(): number;
DataSnapshot.child()
Belirtilen göreli yoldaki konum için başka bir DataSnapshot
alır.
Bir DataSnapshot'ın child()
yöntemine göreli bir yol iletmek, belirtilen göreli yoldaki konum için başka bir DataSnapshot
döndürür. Göreli yol, basit bir alt ad (örneğin, "ada") veya daha derin, eğik çizgiyle ayrılmış bir yol (örneğin, "ada/ad/ilk") olabilir. Alt konumun verisi yoksa boş bir DataSnapshot
(yani değeri null
olan bir DataSnapshot
) Geri döndü.
İmza:
child(path: string): DataSnapshot;
Parametreler
Parametre | Tip | Tanım |
---|---|---|
yol | sicim | Alt verilerin konumuna ilişkin göreceli bir yol. |
İadeler:
DataSnapshot.exists()
Bu DataSnapshot
herhangi bir veri içeriyorsa true değerini döndürür. snapshot.val() !== null
kullanmaktan biraz daha verimlidir .
İmza:
exists(): boolean;
İadeler:
boolean
DataSnapshot.exportVal()
DataSnapshot'ın tüm içeriğini bir JavaScript nesnesi olarak dışa aktarır.
exportVal()
yöntemi val()
yöntemine benzer , öncelik bilgilerinin (varsa) dahil edilmesi haricinde, verilerinizi yedeklemeye uygun hale getirir.
İmza:
exportVal(): any;
İadeler:
herhangi
DataSnapshot'ın JavaScript değeri olarak içeriği (Object, Array, string, number, boolean veya null
).
DataSnapshot.forEach()
IteratedDataSnapshot
üst düzey alt öğeleri numaralandırır .
JavaScript nesnelerinin çalışma şekli nedeniyle, val()
tarafından döndürülen JavaScript nesnesindeki verilerin sıralamasının sunucudaki sıralamayla veya onChildAdded()
olaylarının sıralamasıyla eşleşeceği garanti edilmez. forEach()
ın kullanışlı olduğu yer burasıdır. Bir DataSnapshot
alt öğelerinin sorgu sıralarında yineleneceğini garanti eder.
Açık orderBy*()
yöntemi kullanılmazsa, sonuçlar anahtara göre sıralı olarak döndürülür (öncelikler kullanılmadığı sürece, bu durumda sonuçlar önceliğe göre döndürülür).
İmza:
forEach(action: (child: IteratedDataSnapshot) => boolean | void): boolean;
Parametreler
Parametre | Tip | Tanım |
---|---|---|
aksiyon | (çocuk: IteratedDataSnapshot ) => boolean | geçersiz | Her alt DataSnapshot için çağrılacak bir işlev. Daha fazla numaralandırmayı iptal etmek için geri arama true değerini döndürebilir. |
İadeler:
boolean
true Geri aramanızın true döndürmesi nedeniyle numaralandırma iptal edildiyse true.
DataSnapshot.hasChild()
Belirtilen alt yolun (boş olmayan) verileri varsa true değerini döndürür.
İmza:
hasChild(path: string): boolean;
Parametreler
Parametre | Tip | Tanım |
---|---|---|
yol | sicim | Potansiyel bir çocuğun konumuna göreceli bir yol. |
İadeler:
boolean
true
belirtilen alt yolda veri mevcutsa; aksi takdirde false
.
DataSnapshot.hasChildren()
DataSnapshot
null
olmayan alt özelliklerine sahip olup olmadığını döndürür.
DataSnapshot
herhangi bir alt öğesi olup olmadığını belirlemek için hasChildren()
işlevini kullanabilirsiniz. Eğer öyleyse, bunları forEach()
kullanarak numaralandırabilirsiniz. . Eğer yoksa, o zaman bu anlık görüntü ilkel bir değer içeriyor (bu değer val()
) veya boştur (bu durumda val()
işlevi null
değerini döndürür ).
İmza:
hasChildren(): boolean;
İadeler:
boolean
true bu anlık görüntünün herhangi bir alt öğesi varsa; aksi takdirde yanlış.
DataSnapshot.toJSON()
Bu nesnenin JSON ile seri hale getirilebilir gösterimini döndürür.
İmza:
toJSON(): object | null;
İadeler:
nesne | hükümsüz
DataSnapshot.val()
DataSnapshot
bir JavaScript değeri çıkarır .
DataSnapshot
verilere bağlı olarak val()
yöntemi bir skaler tür (dize, sayı veya boolean), bir dizi veya bir nesne döndürebilir. Ayrıca DataSnapshot
boş olduğunu (veri içermediğini) belirterek null değerini döndürebilir.
İmza:
val(): any;
İadeler:
herhangi
DataSnapshot'ın JavaScript değeri olarak içeriği (Object, Array, string, number, boolean veya null
).