Interfaccia che rappresenta uno snapshot dei dati del database Firebase Realtime.
Firma:
export declare class DataSnapshot implements database.DataSnapshot
Implementa: database.DataSnapshot
Costruttori
Costruttore | Modificatori | Descrizione |
---|---|---|
(costruttore)(dati, percorso, app, istanza) | Costruisce una nuova istanza della classe DataSnapshot |
Proprietà
Proprietà | Modificatori | Tipo | Descrizione |
---|---|---|---|
esempio | corda | ||
chiave | stringa | nullo | La chiave (ultima parte del percorso) della posizione di questo DataSnapshot . L'ultimo token in una posizione del database è considerato la sua chiave. Ad esempio, "ada" è la chiave per il nodo /users/ada/ . L'accesso alla chiave su qualsiasi DataSnapshot restituisce la chiave per la posizione che l'ha generata. Tuttavia, l'accesso alla chiave sull'URL radice di un database restituisce null . | |
rif | database.Riferimento | Restituisce un [ Reference ](/docs/reference/admin/node/admin.database.Reference) al percorso del database in cui si è verificata la scrittura di attivazione. Ha pieno accesso in lettura e scrittura. |
Metodi
Metodo | Modificatori | Descrizione |
---|---|---|
figlio(percorsofiglio) | Ottiene un DataSnapshot per la posizione nel percorso relativo specificato. Il percorso relativo può essere un semplice nome figlio (ad esempio, "ada") o un percorso più profondo separato da barre (ad esempio, "ada/nome/primo"). | |
esiste() | Restituisce true se questo DataSnapshot contiene dati. È leggermente più efficiente rispetto all'utilizzo snapshot.val() !== null . true se questo DataSnapshot contiene dati; in caso contrario, false . | |
valoreesportazione() | Esporta l'intero contenuto di DataSnapshot come oggetto JavaScript. Il contenuto di DataSnapshot come valore JavaScript (Object, Array, string, number, boolean o null ). | |
perEach(azione) | Enumera i DataSnapshot degli elementi figlio. A causa del modo in cui funzionano gli oggetti JavaScript, non è garantito che l'ordinamento dei dati nell'oggetto JavaScript restituito da val() corrisponda all'ordinamento sul server né all'ordinamento degli eventi child_added . È qui che forEach() torna utile. Garantisce che i figli di un DataSnapshot possano essere ripetuti nell'ordine della query. Se non viene utilizzato alcun metodo orderBy*() esplicito, i risultati vengono restituiti ordinati per chiave (a meno che non vengano utilizzate le priorità, nel qual caso i risultati vengono restituiti per priorità). | |
getPriorità() | Ottiene il valore di priorità dei dati in questo DataSnapshot . In alternativa all'utilizzo della priorità, le applicazioni possono ordinare le raccolte in base alle proprietà ordinarie. Vedi [Ordinamento e filtraggio dei dati](/docs/database/web/lists-of-data#sorting_and_filtering_data). Il valore di priorità dei dati. | |
hasChild(percorsofiglio) | Restituisce true se il percorso figlio specificato contiene dati (non null ). | |
haFigli() | Restituisce se DataSnapshot ha o meno proprietà figlie non null . È possibile utilizzare hasChildren() per determinare se un DataSnapshot ha dei figli. In tal caso, puoi enumerarli utilizzando forEach() . In caso contrario, questa istantanea contiene un valore primitivo (che può essere recuperato con val() ) oppure è vuota (nel qual caso val() restituisce null ). true se questo snapshot ha dei figli; altrimenti false . | |
numeroBambini() | Restituisce il numero di proprietà figlie di questo DataSnapshot . Numero di proprietà figlie di questo DataSnapshot . | |
aJSON() | Restituisce una rappresentazione serializzabile JSON di questo oggetto. Una rappresentazione serializzabile JSON di questo oggetto. | |
val() | Estrae un valore JavaScript da un DataSnapshot . A seconda dei dati in un DataSnapshot , il metodo val() può restituire un tipo scalare (stringa, numero o booleano), un array o un oggetto. Potrebbe anche restituire null , indicando che DataSnapshot è vuoto (non contiene dati). Il contenuto dello snapshot come valore JavaScript (Object, Array, string, number, boolean o null ). |
database.DataSnapshot.(costruttore)
Costruisce una nuova istanza della classe DataSnapshot
Firma:
constructor(data: any, path?: string, // path is undefined for the database root
app?: App, instance?: string);
Parametri
Parametro | Tipo | Descrizione |
---|---|---|
dati | Qualunque | |
sentiero | corda | |
app | App | |
esempio | corda |
database.DataSnapshot.istanza
Firma:
instance: string;
database.DataSnapshot.key
La chiave (ultima parte del percorso) della posizione di questo DataSnapshot
.
L'ultimo token in una posizione del database è considerato la sua chiave. Ad esempio, "ada" è la chiave per il nodo /users/ada/
. L'accesso alla chiave su qualsiasi DataSnapshot
restituisce la chiave per la posizione che l'ha generata. Tuttavia, l'accesso alla chiave sull'URL radice di un database restituisce null
.
Firma:
get key(): string | null;
database.DataSnapshot.ref
Restituisce un [ Reference
](/docs/reference/admin/node/admin.database.Reference) nella posizione del database in cui si è verificata l'attivazione della scrittura. Ha pieno accesso in lettura e scrittura.
Firma:
get ref(): database.Reference;
database.DataSnapshot.child()
Ottiene un DataSnapshot
per la posizione nel percorso relativo specificato.
Il percorso relativo può essere un semplice nome figlio (ad esempio, "ada") o un percorso più profondo separato da barre (ad esempio, "ada/nome/primo").
Firma:
child(childPath: string): DataSnapshot;
Parametri
Parametro | Tipo | Descrizione |
---|---|---|
childPath | corda |
Ritorna:
database.DataSnapshot.exists()
Restituisce true
se questo DataSnapshot
contiene dati. È leggermente più efficiente rispetto all'utilizzo snapshot.val() !== null
.
true
se questo DataSnapshot
contiene dati; altrimenti false
.
Firma:
exists(): boolean;
Ritorna:
booleano
database.DataSnapshot.exportVal()
Esporta l'intero contenuto di DataSnapshot
come oggetto JavaScript.
Il contenuto di DataSnapshot
come valore JavaScript (oggetto, array, stringa, numero, booleano o null
).
Firma:
exportVal(): any;
Ritorna:
Qualunque
database.DataSnapshot.forEach()
Enumera DataSnapshot
s degli articoli per bambini.
A causa del modo in cui funzionano gli oggetti JavaScript, non è garantito che l'ordinamento dei dati nell'oggetto JavaScript restituito da val()
corrisponda all'ordinamento sul server né all'ordinamento degli eventi child_added
. È qui che forEach()
torna utile. Garantisce che i figli di un DataSnapshot
possano essere ripetuti nell'ordine della query.
Se non viene utilizzato alcun metodo orderBy*()
esplicito, i risultati vengono restituiti ordinati per chiave (a meno che non vengano utilizzate le priorità, nel qual caso i risultati vengono restituiti per priorità).
Firma:
forEach(action: (a: DataSnapshot) => boolean | void): boolean;
Parametri
Parametro | Tipo | Descrizione |
---|---|---|
azione | (a: DataSnapshot ) => booleano | vuoto | Una funzione che viene chiamata per ogni DataSnapshot figlio. La richiamata può restituire true per annullare un'ulteriore enumerazione. true se l'enumerazione è stata annullata perché la richiamata ha restituito true . |
Ritorna:
booleano
database.DataSnapshot.getPriority()
Ottiene il valore di priorità dei dati in questo DataSnapshot
.
In alternativa all'utilizzo della priorità, le applicazioni possono ordinare le raccolte in base alle proprietà ordinarie. Vedi [Ordinamento e filtraggio dei dati](/docs/database/web/lists-of-data#sorting_and_filtering_data).
Il valore di priorità dei dati.
Firma:
getPriority(): string | number | null;
Ritorna:
stringa | numero | nullo
database.DataSnapshot.hasChild()
Restituisce true
se il percorso figlio specificato ha (non null
) dati.
Firma:
hasChild(childPath: string): boolean;
Parametri
Parametro | Tipo | Descrizione |
---|---|---|
childPath | corda |
Ritorna:
booleano
database.DataSnapshot.hasChildren()
Restituisce se DataSnapshot
ha o meno proprietà figlie non null
.
È possibile utilizzare hasChildren()
per determinare se un DataSnapshot
ha dei figli. In tal caso, puoi enumerarli utilizzando forEach()
. In caso contrario, questa istantanea contiene un valore primitivo (che può essere recuperato con val()
) oppure è vuoto (nel qual caso val()
restituisce null
).
true
se questo snapshot ha dei figli; altrimenti false
.
Firma:
hasChildren(): boolean;
Ritorna:
booleano
database.DataSnapshot.numChildren()
Restituisce il numero di proprietà figlie di questo DataSnapshot
.
Numero di proprietà secondarie di questo DataSnapshot
.
Firma:
numChildren(): number;
Ritorna:
numero
database.DataSnapshot.toJSON()
Restituisce una rappresentazione serializzabile JSON di questo oggetto.
Una rappresentazione serializzabile JSON di questo oggetto.
Firma:
toJSON(): Record<string, unknown>;
Ritorna:
Registra<stringa, sconosciuto>
database.DataSnapshot.val()
Estrae un valore JavaScript da un DataSnapshot
.
A seconda dei dati in un DataSnapshot
, il metodo val()
può restituire un tipo scalare (stringa, numero o booleano), un array o un oggetto. Potrebbe anche restituire null
, indicando che DataSnapshot
è vuoto (non contiene dati).
Il contenuto dello snapshot come valore JavaScript (oggetto, array, stringa, numero, booleano o null
).
Firma:
val(): any;
Ritorna:
Qualunque