Interfaz que representa una instantánea de datos de Firebase Realtime Database.
Firma:
export declare class DataSnapshot implements database.DataSnapshot
Implementaciones: database.DataSnapshot
Constructores
Constructor | Teclas modificadoras | Descripción |
---|---|---|
(constructor)(datos, ruta de acceso, app, instancia) | Construye una instancia nueva de la clase DataSnapshot . |
Propiedades
Propiedad | Teclas modificadoras | Tipo | Descripción |
---|---|---|---|
instancia | string | ||
key | cadena | nulo | La clave (última parte de la ruta de acceso) de la ubicación de este DataSnapshot .El último token de una ubicación en la base de datos se considera su clave. Por ejemplo, "ada" es la clave del nodo /users/ada/ . El acceso a la clave en cualquier DataSnapshot muestra la clave de la ubicación que la generó. Sin embargo, si accedes a la clave en la URL raíz de una base de datos, se muestra null . |
|
referencia | base de datos.Referencia | Muestra un [Reference ](/docs/reference/admin/node/admin.database.Reference) a la ubicación de la base de datos en la que se produjo la escritura de activación. Tiene acceso completo de lectura y escritura. |
Métodos
Método | Teclas modificadoras | Descripción |
---|---|---|
child(childPath) | Obtiene un DataSnapshot para la ubicación en la ruta relativa especificada.La ruta relativa puede ser un nombre secundario simple (por ejemplo, "ada") o una ruta de acceso separada por barras más profundas (por ejemplo, "ada/name/first"). |
|
exists() | Muestra true si este DataSnapshot contiene datos. Es un poco más eficiente que usar snapshot.val() !== null . true si este DataSnapshot contiene datos. de lo contrario, false . |
|
exportVal(). | Exporta todo el contenido de DataSnapshot como un objeto de JavaScript. El contenido de DataSnapshot como un valor de JavaScript (objeto, array, string, número, booleano o null ) |
|
forCada(acción) | Enumera los DataSnapshot de los elementos secundarios.Debido al modo en que funcionan los objetos de JavaScript, no se garantiza que el orden de los datos en el objeto JavaScript que muestra val() coincida con el orden en el servidor ni con el orden de los eventos child_added . Aquí es donde forEach() resulta útil. Garantiza que los elementos secundarios de un DataSnapshot se puedan iterar en el orden de consulta.Si no se usa un método orderBy*() explícito, los resultados se muestran ordenados por clave (a menos que se usen prioridades, en cuyo caso, los resultados se muestran según la prioridad). |
|
getPriority(). | Obtiene el valor de prioridad de los datos en este DataSnapshot .Como alternativa al uso de la prioridad, las aplicaciones pueden ordenar las colecciones por propiedades comunes. Consulta [Cómo ordenar y filtrar datos](/docs/database/web/lists-of-data#sorting_and_filtering_data). El valor de prioridad de los datos. |
|
hasChild(childPath) | Muestra true si la ruta de acceso secundaria especificada tiene datos (que no son null ). |
|
hasChild(). | Muestra si DataSnapshot tiene propiedades secundarias que no sean null .Puedes usar hasChildren() para determinar si un DataSnapshot tiene algún elemento secundario. Si es así, puedes enumerarlos usando forEach() . Si no es así, esta instantánea contiene un valor primitivo (que se puede recuperar con val() ) o está vacía (en cuyo caso, val() muestra null ). true si esta instantánea tiene elementos secundarios más false . |
|
num Children(), | Muestra la cantidad de propiedades secundarias de este DataSnapshot . Cantidad de propiedades secundarias de este DataSnapshot . |
|
toJSON() | Muestra una representación JSON serializable de este objeto. Una representación JSON serializable de este objeto. | |
val() | Extrae un valor de JavaScript de un DataSnapshot .Según los datos de un DataSnapshot , el método val() puede mostrar un tipo escalar (string, número o booleano), un array o un objeto. También puede mostrar null , lo que indica que DataSnapshot está vacío (no contiene datos). El contenido de la instantánea es un valor de JavaScript (objeto, array, string, número, booleano o null ). |
database.DataSnapshot.(constructor)
Construye una instancia nueva de la clase DataSnapshot
.
Firma:
constructor(data: any, path?: string, // path is undefined for the database root
app?: App, instance?: string);
Parámetros
Parámetro | Tipo | Descripción |
---|---|---|
datos | cualquiera | |
ruta | string | |
app | App | |
instancia | string |
database.DataSnapshot.instance
Firma:
instance: string;
database.DataSnapshot.key
La clave (última parte de la ruta de acceso) de la ubicación de este DataSnapshot
.
El último token en una ubicación de la base de datos se considera su clave. Por ejemplo, "ada" es la clave del nodo /users/ada/
. El acceso a la clave en cualquier DataSnapshot
muestra la clave de la ubicación que la generó. Sin embargo, si accedes a la clave en la URL raíz de una base de datos, se muestra null
.
Firma:
get key(): string | null;
database.DataSnapshot.ref
Muestra un [Reference
](/docs/reference/admin/node/admin.database.Reference) a la ubicación de la base de datos en la que se produjo la escritura de activación. Tiene acceso completo de lectura y escritura.
Firma:
get ref(): database.Reference;
database.DataSnapshot.child()
Obtiene un objeto DataSnapshot
para la ubicación en la ruta de acceso relativa especificada.
La ruta de acceso relativa puede ser un nombre secundario simple (por ejemplo, “ada”) o una ruta de acceso separada por barras más profundas (por ejemplo, “ada/nombre/primero”).
Firma:
child(childPath: string): DataSnapshot;
Parámetros
Parámetro | Tipo | Descripción |
---|---|---|
ruta_secundaria | string |
Muestra:
database.DataSnapshot.exists()
Muestra true
si este DataSnapshot
contiene datos. Es un poco más eficiente que usar snapshot.val() !== null
.
true
si este DataSnapshot
contiene datos. de lo contrario, false
.
Firma:
exists(): boolean;
Muestra:
booleano
database.DataSnapshot.exportVal()
Exporta todo el contenido de DataSnapshot
como un objeto de JavaScript.
El contenido de DataSnapshot
como un valor de JavaScript (objeto, array, string, número, booleano o null
)
Firma:
exportVal(): any;
Muestra:
cualquiera
database.DataSnapshot.forEach()
Enumera los DataSnapshot
de los elementos secundarios.
Debido al modo en que funcionan los objetos de JavaScript, no se garantiza que el orden de los datos en el objeto JavaScript que muestra val()
coincida con el orden en el servidor ni con el orden de los eventos child_added
. Aquí es donde forEach()
resulta útil. Garantiza que los elementos secundarios de un DataSnapshot
se puedan iterar en el orden de consulta.
Si no se usa un método orderBy*()
explícito, los resultados se muestran ordenados por clave (a menos que se usen prioridades; en ese caso, los resultados se muestran según la prioridad).
Firma:
forEach(action: (a: DataSnapshot) => boolean | void): boolean;
Parámetros
Parámetro | Tipo | Descripción |
---|---|---|
acción | (a: DataSnapshot) => booleano | anular | Una función que se llama para cada DataSnapshot secundario. La devolución de llamada puede mostrar true para cancelar la enumeración adicional. true si se canceló la enumeración debido a que tu devolución de llamada muestra true . |
Muestra:
booleano
database.DataSnapshot.getPriority()
Obtiene el valor de prioridad de los datos de este DataSnapshot
.
Como alternativa al uso de la prioridad, las aplicaciones pueden ordenar las colecciones por propiedades comunes. Consulta [Cómo ordenar y filtrar datos](/docs/database/web/lists-of-data#sorting_and_filtering_data).
El valor de prioridad de los datos.
Firma:
getPriority(): string | number | null;
Muestra:
cadena | número | nulo
database.DataSnapshot.hasChild()
Muestra true
si la ruta de acceso secundaria especificada tiene datos (que no son null
).
Firma:
hasChild(childPath: string): boolean;
Parámetros
Parámetro | Tipo | Descripción |
---|---|---|
ruta_secundaria | string |
Muestra:
booleano
database.DataSnapshot.hasChildren()
Muestra si DataSnapshot
tiene propiedades secundarias que no sean null
.
Puedes usar hasChildren()
para determinar si un DataSnapshot
tiene elementos secundarios. Si es así, puedes enumerarlos usando forEach()
. Si no es así, esta instantánea contiene un valor primitivo (que se puede recuperar con val()
) o está vacía (en cuyo caso, val()
muestra null
).
true
si esta instantánea tiene elementos secundarios más false
.
Firma:
hasChildren(): boolean;
Muestra:
booleano
database.DataSnapshot.numChildren()
Muestra la cantidad de propiedades secundarias de este DataSnapshot
.
Cantidad de propiedades secundarias de este DataSnapshot
.
Firma:
numChildren(): number;
Muestra:
número
database.DataSnapshot.toJSON()
Muestra una representación JSON serializable de este objeto.
Una representación JSON serializable de este objeto.
Firma:
toJSON(): Record<string, unknown>;
Muestra:
Registro<cadena, desconocida>
database.DataSnapshot.val()
Extrae un valor de JavaScript de un DataSnapshot
.
Según los datos de un DataSnapshot
, el método val()
puede mostrar un tipo escalar (string, número o booleano), un array o un objeto. También puede mostrar null
, lo que indica que DataSnapshot
está vacío (no contiene datos).
El contenido de la instantánea es un valor de JavaScript (objeto, array, cadena, número, booleano o null
).
Firma:
val(): any;
Muestra:
cualquiera