DataSnapshot class

DataSnapshot, bir Veritabanı konumundan veriler içerir.

Veritabanı'ndan her veri okuduğunuzda verileri DataSnapshot olarak alırsınız. on() veya once() ile eklediğiniz etkinlik geri çağırmalarına bir DataSnapshot iletilir. val() yöntemini çağırarak anlık görüntünün içeriğini JavaScript nesnesi olarak ayıklayabilirsiniz. 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 (daha sonra val() öğesini çağırabilirsiniz).

DataSnapshot, bir Veritabanı konumundaki verilerin verimli bir şekilde oluşturulmuş ve sabit bir kopyasıdır. Değiştirilemez ve hiçbir zaman değiştirilmez (verileri değiştirmek için her zaman doğrudan bir Reference üzerinde set() yöntemini çağırırsınız).

İmza:

export declare class DataSnapshot

Özellikler

Özellik Değiştiriciler Tür Açıklama
anahtar dize | boş Bu DataSnapshot konumunun anahtarı (yolun son kısmı).Bir Veritabanı konumundaki son jeton bunun anahtarı olarak kabul edilir. Örneğin, "ada" /users/ada/ düğümünün anahtarıdır. Herhangi bir DataSnapshot üzerindeki anahtara erişmek, anahtarı oluşturan konuma ait anahtarı döndürür. Ancak bir Veritabanının kök URL'sindeki anahtara erişmek null sonucunu döndürür.
öncelik dize | sayı | boş Bu DataSnapshot içindeki verilerin öncelik değerini alır.Uygulamalar, öncelik kullanamaz ancak koleksiyonları normal özelliklere göre sıralayabilir (bkz. Verileri sıralama ve filtreleme).
başvuru DatabaseReference Bu DataSnapshot'ın konumu.
size [beden] sayı Bu DataSnapshot öğesinin alt özelliklerinin sayısını döndürür.

Yöntemler

Yöntem Değiştiriciler Açıklama
child(yol) Belirtilen göreli yoldaki konum için başka bir DataSnapshot alır.Bir DataSnapshot'ın child() yöntemine göreli bir yol geçirildiğinde, belirtilen göreli yoldaki konum için başka bir DataSnapshot döndürülür. Göreli yol, basit bir alt ad (ör. "ada") veya eğik çizgiyle ayrılmış daha derin bir yol (örneğin, "ada/ad/ilk") olabilir. Alt konumda veri yoksa boş bir DataSnapshot (değeri null olan bir DataSnapshot) döndürülür.
exists() Bu DataSnapshot herhangi bir veri içeriyorsa true değerini döndürür. Bu, snapshot.val() !== null kullanımına kıyasla biraz daha verimlidir.
exportVal() DataSnapshot'ın tüm içeriğini JavaScript nesnesi olarak dışa aktarır.exportVal() yöntemi, val() yöntemine benzer ancak öncelik bilgileri (varsa) eklenerek verilerinizin yedeklenmesi için uygundur.
forHer(işlem) IteratedDataSnapshot içindeki en üst düzey alt öğeleri sıralar.JavaScript nesnelerinin çalışma biçimi nedeniyle, val() tarafından döndürülen JavaScript nesnesindeki verilerin sıralamasının, sunucudaki sıralamayla veya onChildAdded() etkinliklerinin sıralamasıyla eşleşeceği garanti edilmez. İşte forEach() burada devreye giriyor. Bir DataSnapshot alt öğesinin sorgu sırasında yineleneceğini garanti eder.Açık bir orderBy*() yöntemi kullanılmazsa sonuçlar anahtara göre sıralanır (öncelikler kullanılmadığı sürece, bu durumda sonuçlar önceliğe göre döndürülür).
hasChild(path) Belirtilen alt yolda (boş olmayan) veri varsa true değerini döndürür.
hasChildren() DataSnapshot öğesinin, null dışında alt mülk olup olmadığını döndürür.DataSnapshot öğesinin alt öğeleri olup olmadığını belirlemek için hasChildren() öğesini kullanabilirsiniz. Numaralandırılıyorsa bunları forEach() kullanarak sıralayabilirsiniz. Aksi takdirde, bu anlık görüntü temel bir değer içerir (val() ile alınabilir) veya boştur (bu durumda val(), null değerini döndürür).
toJSON() Bu nesnenin JSON'de seri hale getirilebilir bir temsilini döndürür.
val() DataSnapshot öğesinden JavaScript değeri çıkarır.DataSnapshot içindeki verilere bağlı olarak val() yöntemi, skaler tür (dize, sayı veya boole), dizi ya da nesne döndürebilir. Ayrıca, DataSnapshot öğesinin boş olduğunu (veri içermediğini) belirten null değeri de döndürebilir.

DataSnapshot.key

Bu DataSnapshot konumunun anahtarı (yolun son kısmı).

Veritabanı konumundaki son jeton bunun anahtarı olarak kabul edilir. Örneğin, "ada" /users/ada/ düğümünün anahtarıdır. Herhangi bir DataSnapshot üzerindeki anahtara erişmek, anahtarı oluşturan konuma ait anahtarı döndürür. Ancak bir Veritabanının kök URL'sindeki anahtara erişmek null sonucunu döndürür.

İmza:

get key(): string | null;

DataSnapshot.öncelik

Bu DataSnapshot içindeki verilerin öncelik değerini alır.

Uygulamaların öncelik kullanması gerekmez ancak koleksiyonları normal mülklere göre sıralayabilir (Verileri sıralama ve filtreleme bölümüne bakın).

İmza:

get priority(): string | number | null;

DataSnapshot.ref

Bu DataSnapshot'ın konumu.

İmza:

readonly ref: DatabaseReference;

DataSnapshot.size

Bu DataSnapshot öğesinin 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 geçirmek, belirtilen göreli yoldaki konum için başka bir DataSnapshot döndürür. Göreli yol, basit bir alt ad (ör. "ada") veya eğik çizgiyle ayrılmış daha derin bir yol (örneğin, "ada/ad/ilk") olabilir. Alt konumda veri yoksa boş bir DataSnapshot (değeri null olan bir DataSnapshot) döndürülür.

İmza:

child(path: string): DataSnapshot;

Parametreler

Parametre Tür Açıklama
yol dize Alt verilerin konumuna giden göreli bir yol.

Şunu döndürür:

DataSnapshot

DataSnapshot.exists()

Bu DataSnapshot herhangi bir veri içeriyorsa true değerini döndürür. Bu, snapshot.val() !== null kullanımına kıyasla biraz daha verimlidir.

İmza:

exists(): boolean;

Şunu döndürür:

boolean

DataSnapshot.exportVal()

DataSnapshot'ın tüm içeriğini JavaScript nesnesi olarak dışa aktarır.

exportVal() yöntemi, val() yöntemine benzer ancak öncelik bilgileri (varsa) dahil edildiğinden verilerinizin yedeklenmesi için uygundur.

İmza:

exportVal(): any;

Şunu döndürür:

herhangi bir

JavaScript değeri olarak DataSnapshot içerikleri (Nesne, Dizi, dize, sayı, boole veya null).

DataSnapshot.forEvery()

IteratedDataSnapshot içindeki en üst düzey alt öğeleri belirtir.

JavaScript nesnelerinin çalışma şeklinden dolayı, val() tarafından döndürülen JavaScript nesnesindeki verilerin sıralamasının, sunucudaki sıralamayla veya onChildAdded() etkinliklerinin sıralamasıyla eşleşeceği garanti edilmez. İşte forEach() burada devreye giriyor. DataSnapshot öğesinin alt öğelerinin sorgu sıralarında yineleneceğini garanti eder.

Açık bir orderBy*() yöntemi kullanılmazsa sonuçlar anahtara göre sıralanı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 Tür Açıklama
işlem (alt: IteratedDataSnapshot) => boole | geçersiz Her alt DataSnapshot için çağrılacak bir işlev. Geri çağırma, daha fazla numaralandırmayı iptal etmek için true değerini döndürebilir.

Şunu döndürür:

boolean

geri çağırma işlevinizin true döndürmesi nedeniyle numaralandırma iptal edildiyse true değerini alır.

DataSnapshot.hasChild()

Belirtilen alt yolda (boş olmayan) veri varsa true değerini döndürür.

İmza:

hasChild(path: string): boolean;

Parametreler

Parametre Tür Açıklama
yol dize Potansiyel bir çocuğun bulunduğu konuma giden göreli bir yol.

Şunu döndürür:

boolean

Belirtilen alt yolda veri varsa true; else false.

DataSnapshot.hasChildren()

DataSnapshot öğesinin, null olmayan alt mülklerin olup olmadığını döndürür.

Bir DataSnapshot öğesinin alt öğesi olup olmadığını belirlemek için hasChildren() kullanabilirsiniz. Bu durumda, öğeleri forEach() kullanarak sıralayabilirsiniz. Aksi takdirde, bu anlık görüntü temel bir değer içerir (val() ile alınabilir) veya boştur (bu durumda val(), null değerini döndürür).

İmza:

hasChildren(): boolean;

Şunu döndürür:

boolean

bu anlık görüntünün alt öğeleri varsa true; else false.

DataSnapshot.toJSON()

Bu nesnenin JSON'de seri hale getirilebilir bir temsilini döndürür.

İmza:

toJSON(): object | null;

Şunu döndürür:

nesne | boş

DataSnapshot.val()

DataSnapshot öğesinden JavaScript değerini çıkarır.

DataSnapshot içindeki verilere bağlı olarak, val() yöntemi skaler tür (dize, sayı veya boole), dizi veya nesne döndürebilir. Ayrıca, DataSnapshot öğesinin boş olduğunu (veri içermediğini) belirten null değeri de döndürebilir.

İmza:

val(): any;

Şunu döndürür:

herhangi bir

JavaScript değeri olarak DataSnapshot içerikleri (Nesne, Dizi, dize, sayı, boole veya null).