Antarmuka yang menampilkan snapshot data database Firebase Realtime.
Tanda Tangan:
export declare class DataSnapshot implements database.DataSnapshot
Mengimplementasikan: database.DataSnapshot
Konstruktor
Konstruktor | Pengubah | Deskripsi |
---|---|---|
(konstruktor)(data, jalur, aplikasi, instance) | Membuat instance baru dari class DataSnapshot |
Properti
Properti | Pengubah | Jenis | Deskripsi |
---|---|---|---|
instance | string | ||
key | rangkaian | null (kosong) | Kunci (bagian terakhir jalur) lokasi DataSnapshot ini.Token terakhir di lokasi database dianggap sebagai kuncinya. Misalnya, "ada" adalah kunci untuk node /users/ada/ . Mengakses kunci di DataSnapshot akan menampilkan kunci untuk lokasi yang membuatnya. Namun, mengakses kunci di URL root database akan menampilkan null . |
|
referensi | database.Reference | Menampilkan [Reference ](/docs/reference/admin/node/admin.database.Reference) ke lokasi database tempat terjadinya penulisan pemicu. Memiliki akses baca dan tulis penuh. |
Metode
Metode | Pengubah | Deskripsi |
---|---|---|
child(childPath) | Mendapatkan DataSnapshot untuk lokasi di jalur relatif yang ditentukan.Jalur relatif dapat berupa nama turunan sederhana (misalnya, "ada") atau jalur yang dipisahkan garis miring yang lebih dalam (misalnya, "ada/name/first"). |
|
exists() | Menampilkan true jika DataSnapshot ini berisi data. Ini sedikit lebih efisien daripada menggunakan snapshot.val() !== null . true jika DataSnapshot ini berisi data; jika tidak, false . |
|
exportVal() | Mengekspor seluruh konten DataSnapshot sebagai objek JavaScript. Konten DataSnapshot sebagai nilai JavaScript (Objek, Array, string, angka, boolean, atau null ). |
|
forSetiap(tindakan) | Menghitung DataSnapshot item turunan.Karena cara kerja objek JavaScript, urutan data dalam objek JavaScript yang ditampilkan oleh val() tidak dijamin cocok dengan pengurutan di server atau urutan peristiwa child_added . Di sinilah forEach() berguna. Hal ini menjamin turunan DataSnapshot dapat diiterasi dalam urutan kuerinya.Jika tidak ada metode orderBy*() eksplisit yang digunakan, hasil akan diurutkan berdasarkan kunci (kecuali jika prioritas digunakan, dalam hal ini, hasilnya akan ditampilkan berdasarkan prioritas). |
|
getPriority() | Mendapatkan nilai prioritas data dalam DataSnapshot ini.Sebagai alternatif untuk menggunakan prioritas, aplikasi dapat mengurutkan koleksi berdasarkan properti biasa. Lihat [Mengurutkan dan memfilter data](/docs/database/web/lists-of-data#sorting_and_filtering_data). Nilai prioritas data. |
|
hasChild(childPath) | Menampilkan true jika jalur turunan yang ditentukan memiliki data (non-null ). |
|
hasChildren() | Menampilkan apakah DataSnapshot memiliki properti turunan non-null atau tidak.Anda dapat menggunakan hasChildren() untuk menentukan apakah DataSnapshot memiliki turunan. Jika ya, Anda dapat menghitungnya menggunakan forEach() . Jika tidak, snapshot ini berisi nilai primitif (yang dapat diambil dengan val() ) atau kosong (dalam hal ini, val() menampilkan null ). true jika snapshot ini memiliki turunan; lainnya false . |
|
numChildren() | Menampilkan jumlah properti turunan dari DataSnapshot ini. Jumlah properti turunan dari DataSnapshot ini. |
|
toJSON() | Menampilkan representasi JSON-serial yang dapat diserialisasi dari objek ini. Representasi JSON yang dapat diserialisasi untuk objek ini. | |
val() | Mengekstrak nilai JavaScript dari DataSnapshot .Bergantung pada data dalam DataSnapshot , metode val() dapat menampilkan jenis skalar (string, angka, atau boolean), array, atau objek. Kode ini juga dapat menampilkan null , yang menunjukkan bahwa DataSnapshot kosong (tidak berisi data). Konten snapshot sebagai nilai JavaScript (Objek, Array, string, angka, boolean, atau null ). |
database.DataSnapshot.(konstruktor)
Membuat instance baru dari class DataSnapshot
Tanda Tangan:
constructor(data: any, path?: string, // path is undefined for the database root
app?: App, instance?: string);
Parameter
Parameter | Jenis | Deskripsi |
---|---|---|
data | apa pun | |
jalur | string | |
aplikasi | Aplikasi | |
instance | string |
database.DataSnapshot.instance
Tanda Tangan:
instance: string;
database.DataSnapshot.key
Kunci (bagian terakhir jalur) lokasi DataSnapshot
ini.
Token terakhir dalam lokasi database dianggap sebagai kuncinya. Misalnya, "ada" adalah kunci untuk node /users/ada/
. Mengakses kunci di DataSnapshot
akan menampilkan kunci untuk lokasi yang membuatnya. Namun, mengakses kunci di URL root database akan menampilkan null
.
Tanda Tangan:
get key(): string | null;
database.DataSnapshot.ref
Menampilkan [Reference
](/docs/reference/admin/node/admin.database.Reference) ke lokasi database tempat terjadinya penulisan pemicu. Memiliki akses baca dan tulis penuh.
Tanda Tangan:
get ref(): database.Reference;
database.DataSnapshot.child()
Mendapatkan DataSnapshot
untuk lokasi di jalur relatif yang ditentukan.
Jalur relatif dapat berupa nama turunan sederhana (misalnya, "ada") atau jalur yang dipisahkan garis miring yang lebih dalam (misalnya, "ada/name/first").
Tanda Tangan:
child(childPath: string): DataSnapshot;
Parameter
Parameter | Jenis | Deskripsi |
---|---|---|
childPath | string |
Hasil:
database.DataSnapshot.exists()
Menampilkan true
jika DataSnapshot
ini berisi data. Hal ini sedikit lebih efisien daripada menggunakan snapshot.val() !== null
.
true
jika DataSnapshot
ini berisi data; jika tidak, false
.
Tanda Tangan:
exists(): boolean;
Hasil:
boolean
database.DataSnapshot.exportVal()
Mengekspor seluruh konten DataSnapshot
sebagai objek JavaScript.
Konten DataSnapshot
sebagai nilai JavaScript (Objek, Array, string, angka, boolean, atau null
).
Tanda Tangan:
exportVal(): any;
Hasil:
apa pun
database.DataSnapshot.forSetiap()
Menghitung DataSnapshot
item turunan.
Karena cara kerja objek JavaScript, urutan data dalam objek JavaScript yang ditampilkan oleh val()
tidak dijamin akan cocok dengan pengurutan di server atau urutan peristiwa child_added
. Di sinilah forEach()
berguna. Metode ini menjamin turunan DataSnapshot
dapat diiterasi dalam urutan kueri mereka.
Jika tidak ada metode orderBy*()
eksplisit yang digunakan, hasil akan ditampilkan yang diurutkan berdasarkan kunci (kecuali jika prioritas digunakan, dalam hal ini, hasilnya akan ditampilkan berdasarkan prioritas).
Tanda Tangan:
forEach(action: (a: DataSnapshot) => boolean | void): boolean;
Parameter
Parameter | Jenis | Deskripsi |
---|---|---|
action | (a: DataSnapshot) => boolean | kosong | Fungsi yang dipanggil untuk setiap turunan DataSnapshot . Callback dapat menampilkan true untuk membatalkan enumerasi lebih lanjut. true jika enumerasi dibatalkan karena callback Anda menampilkan true . |
Hasil:
boolean
database.DataSnapshot.getPriority()
Mendapatkan nilai prioritas data dalam DataSnapshot
ini.
Sebagai alternatif penggunaan prioritas, aplikasi dapat mengurutkan koleksi berdasarkan properti biasa. Lihat [Mengurutkan dan memfilter data](/docs/database/web/lists-of-data#sorting_and_filtering_data).
Nilai prioritas data.
Tanda Tangan:
getPriority(): string | number | null;
Hasil:
rangkaian | angka | null (kosong)
database.DataSnapshot.hasChild()
Menampilkan true
jika jalur turunan yang ditentukan memiliki data (non-null
).
Tanda Tangan:
hasChild(childPath: string): boolean;
Parameter
Parameter | Jenis | Deskripsi |
---|---|---|
childPath | string |
Hasil:
boolean
database.DataSnapshot.hasChildren()
Menampilkan apakah DataSnapshot
memiliki properti turunan non-null
atau tidak.
Anda dapat menggunakan hasChildren()
untuk menentukan apakah DataSnapshot
memiliki turunan. Jika ya, Anda dapat menghitungnya menggunakan forEach()
. Jika tidak, snapshot ini berisi nilai primitif (yang dapat diambil dengan val()
) atau kosong (dalam hal ini, val()
menampilkan null
).
true
jika snapshot ini memiliki turunan; Lainnya false
.
Tanda Tangan:
hasChildren(): boolean;
Hasil:
boolean
database.DataSnapshot.numChildren()
Menampilkan jumlah properti turunan dari DataSnapshot
ini.
Jumlah properti turunan dari DataSnapshot
ini.
Tanda Tangan:
numChildren(): number;
Hasil:
angka
database.DataSnapshot.toJSON()
Menampilkan representasi JSON-serial yang dapat diserialisasi dari objek ini.
Representasi JSON yang dapat diserialisasi untuk objek ini.
Tanda Tangan:
toJSON(): Record<string, unknown>;
Hasil:
Rekam<string, tidak diketahui>
database.DataSnapshot.val()
Mengekstrak nilai JavaScript dari DataSnapshot
.
Bergantung pada data dalam DataSnapshot
, metode val()
dapat menampilkan jenis skalar (string, angka, atau boolean), array, atau objek. Fungsi ini juga dapat menampilkan null
, yang menunjukkan bahwa DataSnapshot
kosong (tidak berisi data).
Konten snapshot sebagai nilai JavaScript (Objek, Array, string, angka, boolean, atau null
).
Tanda Tangan:
val(): any;
Hasil:
apa pun