database.DataSnapshot class

Interface que representa um snapshot de dados do banco de dados Firebase Realtime.

Assinatura:

export declare class DataSnapshot implements database.DataSnapshot

Implementa: banco de dados.DataSnapshot

Construtores

Construtor Modificadores Descrição
(construtor)(dados, caminho, aplicativo, instância) Constrói uma nova instância da classe DataSnapshot

Propriedades

Propriedade Modificadores Tipo Descrição
instância corda
chave corda | nulo A chave (última parte do caminho) da localização deste DataSnapshot . O último token em um local de banco de dados é considerado sua chave. Por exemplo, "ada" é a chave para o nó /users/ada/ . Acessar a chave em qualquer DataSnapshot retorna a chave do local que o gerou. No entanto, acessar a chave na URL raiz de um banco de dados retorna null .
referência banco de dados.Referência Retorna uma [ Reference ](/docs/reference/admin/node/admin.database.Reference) para o local do banco de dados onde ocorreu a gravação acionadora. Possui acesso total de leitura e gravação.

Métodos

Método Modificadores Descrição
filho(caminhofilho) Obtém um DataSnapshot para o local no caminho relativo especificado. O caminho relativo pode ser um nome filho simples (por exemplo, "ada") ou um caminho mais profundo separado por barras (por exemplo, "ada/nome/primeiro").
existe() Retornará true se este DataSnapshot contiver algum dado. É um pouco mais eficiente do que usar snapshot.val() !== null . true se este DataSnapshot contiver algum dado; caso contrário, false .
exportVal() Exporta todo o conteúdo do DataSnapshot como um objeto JavaScript. O conteúdo do DataSnapshot como um valor JavaScript (Object, Array, string, number, boolean ou null ).
forEach(ação) Enumera os DataSnapshot s dos itens filhos. Devido à forma como os objetos JavaScript funcionam, não há garantia de que a ordem dos dados no objeto JavaScript retornado por val() corresponda à ordem no servidor nem à ordem dos eventos child_added . É aí que forEach() se torna útil. Ele garante que os filhos de um DataSnapshot possam ser iterados em sua ordem de consulta. Se nenhum método orderBy*() explícito for usado, os resultados serão retornados ordenados por chave (a menos que sejam usadas prioridades; nesse caso, os resultados serão retornados por prioridade).
getPrioridade() Obtém o valor de prioridade dos dados neste DataSnapshot . Como alternativa ao uso de prioridade, os aplicativos podem ordenar as coleções por propriedades comuns. Consulte [Classificação e filtragem de dados](/docs/database/web/lists-of-data#sorting_and_filtering_data). O valor de prioridade dos dados.
hasChild(caminhofilho) Retorna true se o caminho filho especificado tiver dados (não null ).
temCrianças() Retorna se o DataSnapshot tem ou não propriedades filho não null . Você pode usar hasChildren() para determinar se um DataSnapshot tem algum filho. Se isso acontecer, você pode enumerá-los usando forEach() . Caso contrário, este instantâneo contém um valor primitivo (que pode ser recuperado com val() ) ou está vazio (nesse caso, val() retorna null ). true se este instantâneo tiver algum filho; senão false .
numCrianças() Retorna o número de propriedades filhas deste DataSnapshot . Número de propriedades filhas deste DataSnapshot .
paraJSON() Retorna uma representação serializável JSON deste objeto. Uma representação serializável JSON deste objeto.
val() Extrai um valor JavaScript de um DataSnapshot . Dependendo dos dados em DataSnapshot , o método val() pode retornar um tipo escalar (string, número ou booleano), uma matriz ou um objeto. Também pode retornar null , indicando que o DataSnapshot está vazio (não contém dados). O conteúdo do snapshot como um valor JavaScript (Object, Array, string, number, boolean ou null ).

banco de dados.DataSnapshot.(construtor)

Constrói uma nova instância da classe DataSnapshot

Assinatura:

constructor(data: any, path?: string, // path is undefined for the database root
    app?: App, instance?: string);

Parâmetros

Parâmetro Tipo Descrição
dados qualquer
caminho corda
aplicativo Aplicativo
instância corda

banco de dados.DataSnapshot.instance

Assinatura:

instance: string;

banco de dados.DataSnapshot.key

A chave (última parte do caminho) da localização deste DataSnapshot .

O último token em um local de banco de dados é considerado sua chave. Por exemplo, "ada" é a chave para o nó /users/ada/ . Acessar a chave em qualquer DataSnapshot retorna a chave do local que o gerou. No entanto, acessar a chave na URL raiz de um banco de dados retorna null .

Assinatura:

get key(): string | null;

banco de dados.DataSnapshot.ref

Retorna uma [ Reference ](/docs/reference/admin/node/admin.database.Reference) para o local do banco de dados onde ocorreu a gravação de acionamento. Possui acesso total de leitura e gravação.

Assinatura:

get ref(): database.Reference;

banco de dados.DataSnapshot.child()

Obtém um DataSnapshot para o local no caminho relativo especificado.

O caminho relativo pode ser um nome filho simples (por exemplo, "ada") ou um caminho mais profundo separado por barras (por exemplo, "ada/nome/primeiro").

Assinatura:

child(childPath: string): DataSnapshot;

Parâmetros

Parâmetro Tipo Descrição
caminhofilho corda

Retorna:

Instantâneo de dados

banco de dados.DataSnapshot.exists()

Retornará true se este DataSnapshot contiver algum dado. É um pouco mais eficiente do que usar snapshot.val() !== null .

true se este DataSnapshot contiver algum dado; caso contrário, false .

Assinatura:

exists(): boolean;

Retorna:

boleano

banco de dados.DataSnapshot.exportVal()

Exporta todo o conteúdo do DataSnapshot como um objeto JavaScript.

O conteúdo do DataSnapshot como um valor JavaScript (Object, Array, string, number, boolean ou null ).

Assinatura:

exportVal(): any;

Retorna:

qualquer

banco de dados.DataSnapshot.forEach()

Enumera o DataSnapshot s dos itens filhos.

Devido à forma como os objetos JavaScript funcionam, não há garantia de que a ordem dos dados no objeto JavaScript retornado por val() corresponda à ordem no servidor nem à ordem dos eventos child_added . É aí que forEach() se torna útil. Ele garante que os filhos de um DataSnapshot possam ser iterados em sua ordem de consulta.

Se nenhum método orderBy*() explícito for usado, os resultados serão retornados ordenados por chave (a menos que sejam usadas prioridades; nesse caso, os resultados serão retornados por prioridade).

Assinatura:

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

Parâmetros

Parâmetro Tipo Descrição
Ação (a: IteratedDataSnapshot) => booleano | vazio Uma função que é chamada para cada DataSnapshot filho. O retorno de chamada pode retornar true para cancelar enumerações adicionais. true se a enumeração foi cancelada devido ao retorno de chamada true .

Retorna:

boleano

banco de dados.DataSnapshot.getPriority()

Obtém o valor de prioridade dos dados neste DataSnapshot .

Como alternativa ao uso de prioridade, os aplicativos podem ordenar as coleções por propriedades comuns. Consulte [Classificação e filtragem de dados](/docs/database/web/lists-of-data#sorting_and_filtering_data).

O valor de prioridade dos dados.

Assinatura:

getPriority(): string | number | null;

Retorna:

corda | número | nulo

banco de dados.DataSnapshot.hasChild()

Retorna true se o caminho filho especificado tiver (não null ) dados.

Assinatura:

hasChild(childPath: string): boolean;

Parâmetros

Parâmetro Tipo Descrição
caminhofilho corda

Retorna:

boleano

banco de dados.DataSnapshot.hasChildren()

Retorna se o DataSnapshot tem ou não propriedades filho não null .

Você pode usar hasChildren() para determinar se um DataSnapshot tem algum filho. Se isso acontecer, você pode enumerá-los usando forEach() . Caso contrário, então este instantâneo contém um valor primitivo (que pode ser recuperado com val() ) ou está vazio (nesse caso, val() retorna null ).

true se este instantâneo tiver algum filho; senão false .

Assinatura:

hasChildren(): boolean;

Retorna:

boleano

banco de dados.DataSnapshot.numChildren()

Retorna o número de propriedades filhas deste DataSnapshot .

Número de propriedades filhas deste DataSnapshot .

Assinatura:

numChildren(): number;

Retorna:

número

banco de dados.DataSnapshot.toJSON()

Retorna uma representação serializável JSON deste objeto.

Uma representação serializável JSON deste objeto.

Assinatura:

toJSON(): Record<string, unknown>;

Retorna:

Registro<string, desconhecido>

banco de dados.DataSnapshot.val()

Extrai um valor JavaScript de um DataSnapshot .

Dependendo dos dados em um DataSnapshot , o método val() pode retornar um tipo escalar (string, número ou booleano), uma matriz ou um objeto. Também pode retornar null , indicando que o DataSnapshot está vazio (não contém dados).

O conteúdo do instantâneo como um valor JavaScript (objeto, matriz, string, número, booleano ou null ).

Assinatura:

val(): any;

Retorna:

qualquer