database.DataSnapshot class

Interfaz que representa una instantánea de datos de la base de datos de Firebase Realtime.

Firma:

export declare class DataSnapshot implements database.DataSnapshot

Implementos: base de datos.DataSnapshot

Constructores

Constructor Modificadores Descripción
(constructor)(datos, ruta, aplicación, instancia) Construye una nueva instancia de la clase DataSnapshot

Propiedades

Propiedad Modificadores Tipo Descripción
instancia cadena
llave cadena | nulo La clave (última parte de la ruta) de la ubicación de este DataSnapshot . El último token en una ubicación de base de datos se considera su clave. Por ejemplo, "ada" es la clave para el nodo /users/ada/ . Al acceder a la clave en cualquier DataSnapshot se devuelve la clave de la ubicación que la generó. Sin embargo, acceder a la clave en la URL raíz de una base de datos devuelve null .
árbitro base de datos.Referencia Devuelve una [ Reference ](/docs/reference/admin/node/admin.database.Reference) a la ubicación de la base de datos donde ocurrió la escritura desencadenante. Tiene acceso completo de lectura y escritura.

Métodos

Método Modificadores Descripción
niño(rutaniño) Obtiene una 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 más profunda separada por barras (por ejemplo, "ada/nombre/primero").
existe() Devuelve true si esta DataSnapshot contiene datos. Es un poco más eficiente que usar snapshot.val() !== null . true si esta DataSnapshot contiene datos; en caso contrario, false .
exportVal() Exporta todo el contenido de DataSnapshot como un objeto JavaScript. El contenido de DataSnapshot como un valor de JavaScript (Objeto, Matriz, cadena, número, booleano o null ).
para cada (acción) Enumera las DataSnapshot de los elementos secundarios. Debido a la forma en que funcionan los objetos JavaScript, no se garantiza que el orden de los datos en el objeto JavaScript devuelto por val() coincida con el orden en el servidor ni con el orden de los eventos child_added . Ahí es donde forEach() resulta útil. Garantiza que los elementos secundarios de una DataSnapshot se puedan iterar en su orden de consulta. Si no se utiliza ningún método explícito orderBy*() , los resultados se devuelven ordenados por clave (a menos que se utilicen prioridades, en cuyo caso, los resultados se devuelven por prioridad).
obtenerPrioridad() Obtiene el valor de prioridad de los datos en este DataSnapshot . Como alternativa al uso de prioridad, las aplicaciones pueden ordenar colecciones por propiedades ordinarias. Consulte [Ordenar y filtrar datos](/docs/database/web/lists-of-data#sorting_and_filtering_data). El valor de prioridad de los datos.
tieneniño(rutaniño) Devuelve true si la ruta secundaria especificada tiene datos (no null ).
tiene niños() Devuelve si el DataSnapshot tiene o no propiedades secundarias no null . Puede utilizar hasChildren() para determinar si una DataSnapshot tiene hijos. Si es así, puedes enumerarlos usando forEach() . Si no es así, entonces esta instantánea contiene un valor primitivo (que se puede recuperar con val() ) o está vacía (en cuyo caso, val() devuelve null ). true si esta instantánea tiene hijos; de lo contrario false .
numNiños() Devuelve el número de propiedades secundarias de este DataSnapshot . Número de propiedades secundarias de este DataSnapshot .
a JSON() Devuelve una representación serializable JSON de este objeto. Una representación serializable en JSON de este objeto.
valor() Extrae un valor de JavaScript de un DataSnapshot . Dependiendo de los datos en un DataSnapshot , el método val() puede devolver un tipo escalar (cadena, número o booleano), una matriz o un objeto. También puede devolver null , lo que indica que el DataSnapshot está vacío (no contiene datos). El contenido de la instantánea como un valor de JavaScript (objeto, matriz, cadena, número, booleano o null ).

base de datos.DataSnapshot.(constructor)

Construye una nueva instancia 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 cualquier
camino cadena
aplicación Aplicación
instancia cadena

base de datos.DataSnapshot.instancia

Firma:

instance: string;

base de datos.DataSnapshot.key

La clave (última parte de la ruta) de la ubicación de esta DataSnapshot .

El último token en una ubicación de base de datos se considera su clave. Por ejemplo, "ada" es la clave para el nodo /users/ada/ . Al acceder a la clave en cualquier DataSnapshot se devuelve la clave de la ubicación que la generó. Sin embargo, acceder a la clave en la URL raíz de una base de datos devuelve null .

Firma:

get key(): string | null;

base de datos.DataSnapshot.ref

Devuelve un [ Reference ](/docs/reference/admin/node/admin.database.Reference) a la ubicación de la base de datos donde ocurrió la escritura desencadenante. Tiene acceso completo de lectura y escritura.

Firma:

get ref(): database.Reference;

base de datos.DataSnapshot.child()

Obtiene una 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 más profunda separada por barras (por ejemplo, "ada/nombre/primero").

Firma:

child(childPath: string): DataSnapshot;

Parámetros

Parámetro Tipo Descripción
niñoRuta cadena

Devoluciones:

Instantánea de datos

base de datos.DataSnapshot.existe()

Devuelve true si esta DataSnapshot contiene datos. Es un poco más eficiente que usar snapshot.val() !== null .

true si esta DataSnapshot contiene datos; de lo contrario, false .

Firma:

exists(): boolean;

Devoluciones:

booleano

base de datos.DataSnapshot.exportVal()

Exporta todo el contenido de DataSnapshot como un objeto JavaScript.

El contenido de la DataSnapshot como un valor de JavaScript (objeto, matriz, cadena, número, booleano o null ).

Firma:

exportVal(): any;

Devoluciones:

cualquier

base de datos.DataSnapshot.forEach()

Enumera la DataSnapshot s de los artículos infantiles.

Debido a la forma en que funcionan los objetos JavaScript, no se garantiza que el orden de los datos en el objeto JavaScript devuelto por val() coincida con el orden en el servidor ni con el orden de los eventos child_added . Ahí es donde forEach() resulta útil. Garantiza que los elementos secundarios de una DataSnapshot se puedan iterar en su orden de consulta.

Si no se utiliza ningún método explícito orderBy*() , los resultados se devuelven ordenados por clave (a menos que se utilicen prioridades, en cuyo caso, los resultados se devuelven por prioridad).

Firma:

forEach(action: (a: IteratedDataSnapshot) => boolean | void): boolean;

Parámetros

Parámetro Tipo Descripción
acción (a: IteratedDataSnapshot) => booleano | vacío Una función que se llama para cada DataSnapshot secundario. La devolución de llamada puede devolver true para cancelar una enumeración adicional. true si la enumeración se canceló debido a que su devolución de llamada devolvió true .

Devoluciones:

booleano

base de datos.DataSnapshot.getPriority()

Obtiene el valor de prioridad de los datos en esta DataSnapshot .

Como alternativa al uso de prioridad, las aplicaciones pueden ordenar colecciones por propiedades ordinarias. Consulte [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;

Devoluciones:

cadena | número | nulo

base de datos.DataSnapshot.hasChild()

Devuelve true si la ruta secundaria especificada tiene (no null ) datos.

Firma:

hasChild(childPath: string): boolean;

Parámetros

Parámetro Tipo Descripción
niñoRuta cadena

Devoluciones:

booleano

base de datos.DataSnapshot.hasChildren()

Devuelve si el DataSnapshot tiene o no propiedades secundarias no null .

Puede utilizar hasChildren() para determinar si una DataSnapshot tiene hijos. Si es así, puedes enumerarlos usando forEach() . Si no es así, entonces esta instantánea contiene un valor primitivo (que se puede recuperar con val() ) o está vacío (en cuyo caso, val() devuelve null ).

true si esta instantánea tiene hijos; más false .

Firma:

hasChildren(): boolean;

Devoluciones:

booleano

base de datos.DataSnapshot.numChildren()

Devuelve el número de propiedades secundarias de esta DataSnapshot .

Número de propiedades secundarias de esta DataSnapshot .

Firma:

numChildren(): number;

Devoluciones:

número

base de datos.DataSnapshot.toJSON()

Devuelve una representación serializable JSON de este objeto.

Una representación serializable en JSON de este objeto.

Firma:

toJSON(): Record<string, unknown>;

Devoluciones:

Registro<cadena, desconocida>

base de datos.DataSnapshot.val()

Extrae un valor de JavaScript de una DataSnapshot .

Dependiendo de los datos en un DataSnapshot , el método val() puede devolver un tipo escalar (cadena, número o booleano), una matriz o un objeto. También puede devolver null , lo que indica que el DataSnapshot está vacío (no contiene datos).

El contenido de la instantánea como un valor de JavaScript (objeto, matriz, cadena, número, booleano o null ).

Firma:

val(): any;

Devoluciones:

cualquier