database.DataSnapshot class

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

Assinatura:

export declare class DataSnapshot implements database.DataSnapshot

Implementa: database.DataSnapshot

Construtores

Construtor Modificadores Descrição
(construtor)(dados, caminho, app, instância) Cria uma nova instância da classe DataSnapshot

Propriedades

Propriedade Modificadores Tipo Descrição
instance string
key string | nulo A chave (a última parte do caminho) do local desse DataSnapshot.O último token no local de um banco de dados é considerado a chave dele. Por exemplo, "ada" é a chave para o nó /users/ada/. Acessar a chave em qualquer DataSnapshot retorna a chave do local que a gerou. No entanto, acessar a chave no URL raiz de um banco de dados retorna null.
ref database.Reference Retorna um [Reference](/docs/reference/admin/node/admin.database.Reference) para o local do banco de dados em que ocorreu a gravação de acionamento. Tem total acesso de leitura e gravação.

Métodos

Método Modificadores Descrição
child(childPath). Recebe um DataSnapshot para o local no caminho relativo especificado.O caminho relativo pode ser um nome de filho simples (por exemplo, "ada") ou um caminho separado por barras mais profundas (por exemplo, "ada/name/first").
exists(); Retorna true se essa DataSnapshot contiver dados. É um pouco mais eficiente do que usar snapshot.val() !== null. true se esta DataSnapshot tiver dados; caso contrário, false.
exportVal() (em inglês). Exporta todo o conteúdo de DataSnapshot como um objeto JavaScript. O conteúdo de DataSnapshot como um valor JavaScript (objeto, matriz, string, número, booleano ou null).
forCada(ação) (link em inglês) Enumera os DataSnapshots dos itens filhos.Devido ao modo 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 a propriedade forEach() vai ser útil. Isso garante que os filhos de uma DataSnapshot possam ser iterados na ordem da 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(). Recebe o valor de prioridade dos dados na DataSnapshot.Como alternativa ao uso da prioridade, os aplicativos podem ordenar coleções por propriedades comuns. Consulte [Como classificar e filtrar dados](/docs/database/web/lists-of-data#sorting_and_filtering_data). O valor de prioridade dos dados.
hasChild(childPath) Retorna true se o caminho filho especificado tiver dados (não null).
hasChildren() Retorna se DataSnapshot tem ou não propriedades filhas que não sejam null.É possível usar hasChildren() para determinar se uma DataSnapshot tem filhos. Se isso acontecer, você pode enumerá-los usando forEach(). Caso contrário, o snapshot contém um valor primitivo (que pode ser recuperado com val()) ou está vazio (nesse caso, val() retorna null). true se esse snapshot tiver filhos; caso contrário, false.
numChildren() Retorna o número de propriedades filhas desse DataSnapshot. Número de propriedades filhas desse DataSnapshot.
toJSON() (link em inglês) Retorna uma representação serializável do JSON desse objeto. Uma representação serializável do JSON desse objeto.
val() (em inglês) 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. Ele também pode retornar null, indicando que DataSnapshot está vazio (não contém dados). O conteúdo do snapshot como um valor JavaScript (objeto, matriz, string, número, booleano ou null).

database.DataSnapshot.(construtor)

Cria 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 um
path string
app App
instância string

database.DataSnapshot.instance

Assinatura:

instance: string;

database.DataSnapshot.key

A chave (a última parte do caminho) do local deste DataSnapshot.

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

Assinatura:

get key(): string | null;

database.DataSnapshot.ref

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

Assinatura:

get ref(): database.Reference;

database.DataSnapshot.child()

Recebe um DataSnapshot para o local no caminho relativo especificado.

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

Assinatura:

child(childPath: string): DataSnapshot;

Parâmetros

Parâmetro Tipo Descrição
Caminho filho string

Retorna:

DataSnapshot (em inglês)

database.DataSnapshot.exists()

Retorna true se essa DataSnapshot contiver dados. É um pouco mais eficiente do que usar snapshot.val() !== null.

true se esta DataSnapshot tiver dados; caso contrário, false.

Assinatura:

exists(): boolean;

Retorna:

booleano

database.DataSnapshot.exportVal()

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

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

Assinatura:

exportVal(): any;

Retorna:

qualquer um

banco de dados.DataSnapshot.forevery()

Enumera os DataSnapshots 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 a propriedade forEach() vai ser útil. Isso garante que os filhos de um DataSnapshot possam ser iterados na 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: IterifiedDataSnapshot) => booleano | anular Uma função que é chamada para cada DataSnapshot filho. O callback pode retornar true para cancelar outras enumeração. true se a enumeração tiver sido cancelada devido ao retorno de true.

Retorna:

booleano

database.DataSnapshot.getpriority()

Recebe o valor de prioridade dos dados nessa DataSnapshot.

Como alternativa ao uso da prioridade, os aplicativos podem ordenar coleções por propriedades comuns. Consulte [Como classificar e filtrar dados](/docs/database/web/lists-of-data#sorting_and_filtering_data).

O valor de prioridade dos dados.

Assinatura:

getPriority(): string | number | null;

Retorna:

string | número | nulo

database.DataSnapshot.hasChild()

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

Assinatura:

hasChild(childPath: string): boolean;

Parâmetros

Parâmetro Tipo Descrição
Caminho filho string

Retorna:

booleano

database.DataSnapshot.hasChildren()

Retorna se DataSnapshot tem ou não propriedades filhas que não sejam null.

Você pode usar hasChildren() para determinar se uma DataSnapshot tem filhos. Se esse for o caso, você pode enumerá-los usando forEach(). Caso contrário, o snapshot contém um valor primitivo (que pode ser recuperado com val()) ou está vazio (nesse caso, val() retorna null).

true se esse snapshot tiver algum filho; caso contrário, false.

Assinatura:

hasChildren(): boolean;

Retorna:

booleano

database.DataSnapshot.numChildren()

Retorna o número de propriedades filhas desse DataSnapshot.

Número de propriedades filhas desse DataSnapshot.

Assinatura:

numChildren(): number;

Retorna:

number

database.DataSnapshot.toJSON()

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

Uma representação serializável do JSON desse objeto.

Assinatura:

toJSON(): Record<string, unknown>;

Retorna:

Registro<string, desconhecido>

database.DataSnapshot.val()

Extrai um valor JavaScript de um DataSnapshot.

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

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

Assinatura:

val(): any;

Retorna:

qualquer um