database package

Banco de dados em tempo real do Firebase

Funções

Aulas

Interfaces

Aliases de tipo

função (aplicativo, ...)

getDatabase (App, URL)

Retorna a instância do SDK do banco de dados em tempo real que está associado ao FireBaseApp fornecido . Inicializa uma nova instância com as configurações padrão se não houver instância ou se a instância existente usar um URL de banco de dados personalizado.

Assinatura:

export declare function getDatabase(app?: FirebaseApp, url?: string): Database;

Parâmetros

Retorna:

Base de dados

A instância Database do aplicativo fornecido.

função (db, ...)

ConnectDatabaseEmulator (dB, host, porta, opções)

Modifique a instância fornecida para se comunicar com o emulador de banco de dados em tempo real.

Nota: Este método deve ser chamado antes de executar qualquer outra operação.

Assinatura:

export declare function connectDatabaseEmulator(db: Database, host: string, port: number, options?: {
    mockUserToken?: EmulatorMockTokenOptions | string;
}): void;

Parâmetros

Retorna:

vazio

Goffline (DB)

Desconecta do servidor (todas as operações do banco de dados serão concluídas offline).

O cliente mantém automaticamente uma conexão persistente com o servidor de banco de dados, que permanecerá ativo indefinidamente e se reconectará quando desconectado. No entanto, os métodos goOffline() e goOnline() podem ser usados ​​para controlar a conexão do cliente nos casos em que uma conexão persistente é indesejável.

Enquanto offline, o cliente não receberá mais atualizações de dados do banco de dados. No entanto, todas as operações de banco de dados realizadas localmente continuarão a disparar imediatamente eventos, permitindo que seu aplicativo continue se comportando normalmente. Além disso, cada operação executada localmente será automaticamente na fila e se reconecta após a reconexão com o servidor de banco de dados.

Para se reconectar ao banco de dados e começar a receber eventos remotos, consulte goOnline() .

Assinatura:

export declare function goOffline(db: Database): void;

Parâmetros

Retorna:

vazio

goonline (dB)

Reconecte -se ao servidor e sincroniza o estado de banco de dados offline com o estado do servidor.

Este método deve ser usado após desativar a conexão ativa com goOffline() . Depois de reconectada, o cliente transmitirá os dados adequados e disparará os eventos apropriados para que seu cliente "alcance" automaticamente.

Assinatura:

export declare function goOnline(db: Database): void;

Parâmetros

Retorna:

vazio

Ref (dB, caminho)

Retorna uma Reference representando o local no banco de dados correspondente ao caminho fornecido. Se nenhum caminho for fornecido, a Reference apontará para a raiz do banco de dados.

Assinatura:

export declare function ref(db: Database, path?: string): DatabaseReference;

Parâmetros

Retorna:

DatabaseReference

Se um caminho for fornecido, uma Reference apontando para o caminho fornecido. Caso contrário, uma Reference apontando para a raiz do banco de dados.

Reffromurl (dB, URL)

Retorna uma Reference que representa o local no banco de dados correspondente ao URL do FireBase fornecido.

Uma exceção será lançada se o URL não for um URL válido de banco de dados do Firebase ou possui um domínio diferente da instância atual Database .

Observe que todos os parâmetros de consulta ( orderBy , limitToLast , etc.) são ignorados e não são aplicados à Reference retornada .

Assinatura:

export declare function refFromURL(db: Database, url: string): DatabaseReference;

Parâmetros

Retorna:

DatabaseReference

Uma Reference apontando para o URL da base de fogo fornecida.

função()

ForcelongPolling ()

Forçar o uso de longpolling em vez de websockets. Isso será ignorado se o protocolo WebSocket for usado no banco de dados.

Assinatura:

export declare function forceLongPolling(): void;

Retorna:

vazio

Forcewebsockets ()

Forçar o uso de websockets em vez de longpolling.

Assinatura:

export declare function forceWebSockets(): void;

Retorna:

vazio

OrderByKey ()

Cria uma nova QueryConstraint que ordena pela chave.

Classifica os resultados de uma consulta por seus valores de chave (ascendente).

Você pode ler mais sobre orderByKey() em dados de classificação .

Assinatura:

export declare function orderByKey(): QueryConstraint;

Retorna:

QueryConstrain

OrderByPriority ()

Cria uma nova QueryConstraint que ordena por prioridade.

Os aplicativos não precisam usar prioridade, mas podem solicitar coleções por propriedades ordinárias (consulte os dados de classificação para alternativas à prioridade.

Assinatura:

export declare function orderByPriority(): QueryConstraint;

Retorna:

QueryConstrain

OrderByValue ()

Cria uma nova QueryConstraint que ordena por valor.

Se os filhos de uma consulta forem todos valores escalares (string, número ou booleano), você poderá solicitar os resultados pelos valores (ascendentes).

Você pode ler mais sobre orderByValue() em dados de classificação .

Assinatura:

export declare function orderByValue(): QueryConstraint;

Retorna:

QueryConstrain

Servertimestamp ()

Retorna um valor de espaço reservado para população automática do registro de data e hora atual (tempo desde a época da UNIX, em milissegundos), conforme determinado pelos servidores Firebase.

Assinatura:

export declare function serverTimestamp(): object;

Retorna:

objeto

função (delta, ...)

incremento (delta)

Retorna um valor de espaço reservado que pode ser usado para incrementar atomicamente o valor atual do banco de dados pelo delta fornecido.

Assinatura:

export declare function increment(delta: number): object;

Parâmetros

Retorna:

objeto

Um valor de espaço reservado para modificar dados atomicamente do lado do servidor.

função (ativado, ...)

EnableLogging (habilitado, persistente)

Registra informações de depuração no console.

Assinatura:

export declare function enableLogging(enabled: boolean, persistent?: boolean): any;

Parâmetros

Retorna:

qualquer

função (limite, ...)

limitofirst (limite)

Cria uma nova QueryConstraint que, se limitada ao primeiro número específico de crianças.

O método limitToFirst() é usado para definir um número máximo de crianças a serem sincronizadas para um determinado retorno de chamada. Se definirmos um limite de 100, inicialmente receberemos apenas até 100 eventos child_added . Se tivermos menos de 100 mensagens armazenadas em nosso banco de dados, um evento child_added disparará para cada mensagem. No entanto, se tivermos mais de 100 mensagens, receberemos apenas um evento child_added para as 100 primeiras mensagens ordenadas. À medida que os itens mudam, receberemos eventos child_removed para cada item que cai da lista ativa para que o número total permaneça em 100.

Você pode ler mais sobre limitToFirst() na filtragem de dados .

Assinatura:

export declare function limitToFirst(limit: number): QueryConstraint;

Parâmetros

Retorna:

QueryConstrain

Limittolast (limite)

Cria uma nova QueryConstraint , limitada a devolver apenas o último número especificado de crianças.

O método limitToLast() é usado para definir um número máximo de crianças a serem sincronizadas para um determinado retorno de chamada. Se definirmos um limite de 100, inicialmente receberemos apenas até 100 eventos child_added . Se tivermos menos de 100 mensagens armazenadas em nosso banco de dados, um evento child_added disparará para cada mensagem. No entanto, se tivermos mais de 100 mensagens, receberemos apenas um evento child_added para as últimas 100 mensagens ordenadas. À medida que os itens mudam, receberemos eventos child_removed para cada item que cai da lista ativa para que o número total permaneça em 100.

Você pode ler mais sobre limitToLast() na filtragem de dados .

Assinatura:

export declare function limitToLast(limit: number): QueryConstraint;

Parâmetros

Retorna:

QueryConstrain

função (logger, ...)

EnableLogging (Logger)

Registra informações de depuração no console.

Assinatura:

export declare function enableLogging(logger: (message: string) => unknown): any;

Parâmetros

Retorna:

qualquer

função (pai, ...)

criança (pai, caminho)

Obtém uma Reference para o local no caminho relativo especificado.

O caminho relativo pode ser um nome de criança simples (por exemplo, "ADA") ou um caminho mais profundo, separado por barra (por exemplo, "Ada/nome/primeiro").

Assinatura:

export declare function child(parent: DatabaseReference, path: string): DatabaseReference;

Parâmetros

Retorna:

DatabaseReference

A localização infantil especificada.

push (pai, valor)

Gera um novo local infantil usando uma chave única e retorna sua Reference .

Este é o padrão mais comum para adicionar dados a uma coleção de itens.

Se você fornecer um valor para push() , o valor é gravado no local gerado. Se você não passar um valor, nada será gravado no banco de dados e a criança permanece vazia (mas você pode usar a Reference em outro lugar).

As teclas exclusivas geradas pelo push() são ordenadas pelo horário atual, portanto a lista resultante de itens é classificada cronologicamente. As teclas também são projetadas para serem inocentes (elas contêm 72 bits aleatórios de entropia).

Consulte Anexo a uma lista de dados . Veja as 2^120 maneiras de garantir identificadores exclusivos .

Assinatura:

export declare function push(parent: DatabaseReference, value?: unknown): ThenableReference;

Parâmetros

Retorna:

ThenableReference

Promise e Reference combinadas ; Resolve quando a gravação é concluída, mas pode ser usada imediatamente como Reference ao local da criança.

função (caminho, ...)

OrderByChild (caminho)

Cria uma nova QueryConstraint que ordena pela chave da criança especificada.

As consultas só podem encomendar por uma chave por vez. Chamar orderByChild() várias vezes na mesma consulta é um erro.

As consultas do Firebase permitem solicitar seus dados por qualquer chave infantil em tempo real. No entanto, se você souber com antecedência quais serão seus índices, poderá defini -los por meio da regra .Indexon em suas regras de segurança para obter um melhor desempenho. Consulte a regra https://firebase.google.com/docs/database/security/indexing-data para obter mais informações.

Você pode ler mais sobre orderByChild() em dados de classificação .

Assinatura:

export declare function orderByChild(path: string): QueryConstraint;

Parâmetros

Retorna:

QueryConstrain

função (consulta, ...)

Get (consulta)

Obtém o resultado mais atualizado para esta consulta.

Assinatura:

export declare function get(query: Query): Promise<DataSnapshot>;

Parâmetros

Retorna:

Promise < DataSnapshot >

Uma Promise que resolve para o DataSNAPSHOT resultante se um valor estiver disponível ou rejeitar se o cliente não puder retornar um valor (por exemplo, se o servidor for inacessível e não houver nada em cache).

OFF (consulta, eventtype, retorno de chamada)

Destacha um retorno de chamada anteriormente anexado com o correspondente on*() ( onValue , onChildAdded ) ouvinte. Nota: Esta não é a maneira recomendada de remover um ouvinte. Em vez disso, use a função de retorno de chamada retornada dos respectivos on* .

Desconectar um retorno de chamada anteriormente anexado com on*() . Chamar off() Em um ouvinte dos pais não removerá automaticamente os ouvintes registrados nos nós filhos, off() também devem ser chamados para qualquer ouvinte para remover o retorno de chamada.

Se um retorno de chamada não for especificado, todos os retornos de chamada para o EventType especificado serão removidos. Da mesma forma, se nenhum EventType for especificado, todos os retornos de chamada para a Reference serão removidos.

Os ouvintes individuais também podem ser removidos invocando seus retornos de chamada de cancelamento.

Assinatura:

export declare function off(query: Query, eventType?: EventType, callback?: (snapshot: DataSnapshot, previousChildName?: string | null) => unknown): void;

Parâmetros

Retorna:

vazio

OnChildadded (consulta, retorno de chamada, cancelCallback)

Ouve alterações de dados em um local específico.

Esta é a principal maneira de ler dados de um banco de dados. Seu retorno de chamada será acionado para os dados iniciais e novamente sempre que os dados mudarem. Invoque o retorno de chamada de cancelamento de inscrição devolvido para parar de receber atualizações. Consulte Recuperar dados na web para obter mais detalhes.

Um evento onChildAdded será acionado uma vez para cada criança inicial neste local e será acionada novamente toda vez que uma nova criança for adicionada. O DataSnapshot passado para o retorno de chamada refletirá os dados para a criança relevante. Para fins de pedidos, é aprovado um segundo argumento que é uma sequência que contém a chave do filho anterior por ordem de classificação, ou null se for o primeiro filho.

Assinatura:

export declare function onChildAdded(query: Query, callback: (snapshot: DataSnapshot, previousChildName?: string | null) => unknown, cancelCallback?: (error: Error) => unknown): Unsubscribe;

Parâmetros

Retorna:

Cancelar subscrição

Uma função que pode ser invocada para remover o ouvinte.

OnChildadded (consulta, retorno de chamada, opções)

Ouve alterações de dados em um local específico.

Esta é a principal maneira de ler dados de um banco de dados. Seu retorno de chamada será acionado para os dados iniciais e novamente sempre que os dados mudarem. Invoque o retorno de chamada de cancelamento de inscrição devolvido para parar de receber atualizações. Consulte Recuperar dados na web para obter mais detalhes.

Um evento onChildAdded será acionado uma vez para cada criança inicial neste local e será acionada novamente toda vez que uma nova criança for adicionada. O DataSnapshot passado para o retorno de chamada refletirá os dados para a criança relevante. Para fins de pedidos, é aprovado um segundo argumento que é uma sequência que contém a chave do filho anterior por ordem de classificação, ou null se for o primeiro filho.

Assinatura:

export declare function onChildAdded(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, options: ListenOptions): Unsubscribe;

Parâmetros

Retorna:

Cancelar subscrição

Uma função que pode ser invocada para remover o ouvinte.

OnChildadded (consulta, retorno de chamada, cancelCallback, opções)

Ouve alterações de dados em um local específico.

Esta é a principal maneira de ler dados de um banco de dados. Seu retorno de chamada será acionado para os dados iniciais e novamente sempre que os dados mudarem. Invoque o retorno de chamada de cancelamento de inscrição devolvido para parar de receber atualizações. Consulte Recuperar dados na web para obter mais detalhes.

Um evento onChildAdded será acionado uma vez para cada criança inicial neste local e será acionada novamente toda vez que uma nova criança for adicionada. O DataSnapshot passado para o retorno de chamada refletirá os dados para a criança relevante. Para fins de pedidos, é aprovado um segundo argumento que é uma sequência que contém a chave do filho anterior por ordem de classificação, ou null se for o primeiro filho.

Assinatura:

export declare function onChildAdded(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, cancelCallback: (error: Error) => unknown, options: ListenOptions): Unsubscribe;

Parâmetros

Retorna:

Cancelar subscrição

Uma função que pode ser invocada para remover o ouvinte.

OnChildChanged (consulta, retorno de chamada, cancelcallback)

Ouve alterações de dados em um local específico.

Esta é a principal maneira de ler dados de um banco de dados. Seu retorno de chamada será acionado para os dados iniciais e novamente sempre que os dados mudarem. Invoque o retorno de chamada de cancelamento de inscrição devolvido para parar de receber atualizações. Consulte Recuperar dados na web para obter mais detalhes.

Um evento onChildChanged será acionado quando os dados armazenados em uma criança (ou qualquer um de seus descendentes) mudarem. Observe que um único evento child_changed pode representar várias alterações na criança. O DataSnapshot passado para o retorno de chamada conterá o novo conteúdo da criança. Para fins de pedidos, o retorno de chamada também é aprovado em um segundo argumento que é uma string que contém a chave do filho anterior por ordem de classificação por ordem de classificação, ou null se for o primeiro filho.

Assinatura:

export declare function onChildChanged(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, cancelCallback?: (error: Error) => unknown): Unsubscribe;

Parâmetros

Retorna:

Cancelar subscrição

Uma função que pode ser invocada para remover o ouvinte.

OnChildChanged (consulta, retorno de chamada, opções)

Ouve alterações de dados em um local específico.

Esta é a principal maneira de ler dados de um banco de dados. Seu retorno de chamada será acionado para os dados iniciais e novamente sempre que os dados mudarem. Invoque o retorno de chamada de cancelamento de inscrição devolvido para parar de receber atualizações. Consulte Recuperar dados na web para obter mais detalhes.

Um evento onChildChanged será acionado quando os dados armazenados em uma criança (ou qualquer um de seus descendentes) mudarem. Observe que um único evento child_changed pode representar várias alterações na criança. O DataSnapshot passado para o retorno de chamada conterá o novo conteúdo da criança. Para fins de pedidos, o retorno de chamada também é aprovado em um segundo argumento que é uma string que contém a chave do filho anterior por ordem de classificação por ordem de classificação, ou null se for o primeiro filho.

Assinatura:

export declare function onChildChanged(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, options: ListenOptions): Unsubscribe;

Parâmetros

Retorna:

Cancelar subscrição

Uma função que pode ser invocada para remover o ouvinte.

OnChildChanged (consulta, retorno de chamada, cancelcallback, opções)

Ouve alterações de dados em um local específico.

Esta é a principal maneira de ler dados de um banco de dados. Seu retorno de chamada será acionado para os dados iniciais e novamente sempre que os dados mudarem. Invoque o retorno de chamada de cancelamento de inscrição devolvido para parar de receber atualizações. Consulte Recuperar dados na web para obter mais detalhes.

Um evento onChildChanged será acionado quando os dados armazenados em uma criança (ou qualquer um de seus descendentes) mudarem. Observe que um único evento child_changed pode representar várias alterações na criança. O DataSnapshot passado para o retorno de chamada conterá o novo conteúdo da criança. Para fins de pedidos, o retorno de chamada também é aprovado em um segundo argumento que é uma string que contém a chave do filho anterior por ordem de classificação por ordem de classificação, ou null se for o primeiro filho.

Assinatura:

export declare function onChildChanged(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, cancelCallback: (error: Error) => unknown, options: ListenOptions): Unsubscribe;

Parâmetros

Retorna:

Cancelar subscrição

Uma função que pode ser invocada para remover o ouvinte.

OnChildMoved (consulta, retorno de chamada, cancelCallback)

Ouve alterações de dados em um local específico.

Esta é a principal maneira de ler dados de um banco de dados. Seu retorno de chamada será acionado para os dados iniciais e novamente sempre que os dados mudarem. Invoque o retorno de chamada de cancelamento de inscrição devolvido para parar de receber atualizações. Consulte Recuperar dados na web para obter mais detalhes.

Um evento onChildMoved será acionado quando a ordem de classificação de uma criança mudar de modo que sua posição em relação aos irmãos mude. O DataSnapshot passado para o retorno de chamada será para os dados da criança que se moveram. Também é aprovado um segundo argumento que é uma sequência que contém a chave do filho anterior de irmãos por ordem de classificação, ou null se for o primeiro filho.

Assinatura:

export declare function onChildMoved(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, cancelCallback?: (error: Error) => unknown): Unsubscribe;

Parâmetros

Retorna:

Cancelar subscrição

Uma função que pode ser invocada para remover o ouvinte.

OnChildMoved (consulta, retorno de chamada, opções)

Ouve alterações de dados em um local específico.

Esta é a principal maneira de ler dados de um banco de dados. Seu retorno de chamada será acionado para os dados iniciais e novamente sempre que os dados mudarem. Invoque o retorno de chamada de cancelamento de inscrição devolvido para parar de receber atualizações. Consulte Recuperar dados na web para obter mais detalhes.

Um evento onChildMoved será acionado quando a ordem de classificação de uma criança mudar de modo que sua posição em relação aos irmãos mude. O DataSnapshot passado para o retorno de chamada será para os dados da criança que se moveram. Também é aprovado um segundo argumento que é uma sequência que contém a chave do filho anterior de irmãos por ordem de classificação, ou null se for o primeiro filho.

Assinatura:

export declare function onChildMoved(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, options: ListenOptions): Unsubscribe;

Parâmetros

Retorna:

Cancelar subscrição

Uma função que pode ser invocada para remover o ouvinte.

OnChildMoved (consulta, retorno de chamada, cancelcallback, opções)

Ouve alterações de dados em um local específico.

Esta é a principal maneira de ler dados de um banco de dados. Seu retorno de chamada será acionado para os dados iniciais e novamente sempre que os dados mudarem. Invoque o retorno de chamada de cancelamento de inscrição devolvido para parar de receber atualizações. Consulte Recuperar dados na web para obter mais detalhes.

Um evento onChildMoved será acionado quando a ordem de classificação de uma criança mudar de modo que sua posição em relação aos irmãos mude. O DataSnapshot passado para o retorno de chamada será para os dados da criança que se moveram. Também é aprovado um segundo argumento que é uma sequência que contém a chave do filho anterior de irmãos por ordem de classificação, ou null se for o primeiro filho.

Assinatura:

export declare function onChildMoved(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, cancelCallback: (error: Error) => unknown, options: ListenOptions): Unsubscribe;

Parâmetros

Retorna:

Cancelar subscrição

Uma função que pode ser invocada para remover o ouvinte.

OnChildRemoved (consulta, retorno de chamada, cancelcallback)

Ouve alterações de dados em um local específico.

Esta é a principal maneira de ler dados de um banco de dados. Seu retorno de chamada será acionado para os dados iniciais e novamente sempre que os dados mudarem. Invoque o retorno de chamada de cancelamento de inscrição devolvido para parar de receber atualizações. Consulte Recuperar dados na web para obter mais detalhes.

Um evento onChildRemoved será acionado quando toda vez que uma criança for removida. O DataSnapshot passado para o retorno de chamada serão os dados antigos da criança que foi removida. Uma criança será removida quando:

• Um cliente chama explicitamente remove() naquela criança ou em um de seus ancestrais - um cliente chama set(null) nessa criança ou em um de seus ancestrais - essa criança tem todos os seus filhos removidos - há uma consulta em efeito que agora filtra fora da criança (porque sua ordem de classificação foi alterada ou o limite máximo foi atingido)

Assinatura:

export declare function onChildRemoved(query: Query, callback: (snapshot: DataSnapshot) => unknown, cancelCallback?: (error: Error) => unknown): Unsubscribe;

Parâmetros

Retorna:

Cancelar subscrição

Uma função que pode ser invocada para remover o ouvinte.

OnChildRemoved (consulta, retorno de chamada, opções)

Ouve alterações de dados em um local específico.

Esta é a principal maneira de ler dados de um banco de dados. Seu retorno de chamada será acionado para os dados iniciais e novamente sempre que os dados mudarem. Invoque o retorno de chamada de cancelamento de inscrição devolvido para parar de receber atualizações. Consulte Recuperar dados na web para obter mais detalhes.

Um evento onChildRemoved será acionado quando toda vez que uma criança for removida. O DataSnapshot passado para o retorno de chamada serão os dados antigos da criança que foi removida. Uma criança será removida quando:

• Um cliente chama explicitamente remove() naquela criança ou em um de seus ancestrais - um cliente chama set(null) nessa criança ou em um de seus ancestrais - essa criança tem todos os seus filhos removidos - há uma consulta em efeito que agora filtra fora da criança (porque sua ordem de classificação foi alterada ou o limite máximo foi atingido)

Assinatura:

export declare function onChildRemoved(query: Query, callback: (snapshot: DataSnapshot) => unknown, options: ListenOptions): Unsubscribe;

Parâmetros

Retorna:

Cancelar subscrição

Uma função que pode ser invocada para remover o ouvinte.

OnChildRemoved (consulta, retorno de chamada, cancelcallback, opções)

Ouve alterações de dados em um local específico.

Esta é a principal maneira de ler dados de um banco de dados. Seu retorno de chamada será acionado para os dados iniciais e novamente sempre que os dados mudarem. Invoque o retorno de chamada de cancelamento de inscrição devolvido para parar de receber atualizações. Consulte Recuperar dados na web para obter mais detalhes.

Um evento onChildRemoved será acionado quando toda vez que uma criança for removida. O DataSnapshot passado para o retorno de chamada serão os dados antigos da criança que foi removida. Uma criança será removida quando:

• Um cliente chama explicitamente remove() naquela criança ou em um de seus ancestrais - um cliente chama set(null) nessa criança ou em um de seus ancestrais - essa criança tem todos os seus filhos removidos - há uma consulta em efeito que agora filtra fora da criança (porque sua ordem de classificação foi alterada ou o limite máximo foi atingido)

Assinatura:

export declare function onChildRemoved(query: Query, callback: (snapshot: DataSnapshot) => unknown, cancelCallback: (error: Error) => unknown, options: ListenOptions): Unsubscribe;

Parâmetros

Retorna:

Cancelar subscrição

Uma função que pode ser invocada para remover o ouvinte.

onvalue (consulta, retorno de chamada, cancelCallback)

Ouve alterações de dados em um local específico.

Esta é a principal maneira de ler dados de um banco de dados. Seu retorno de chamada será acionado para os dados iniciais e novamente sempre que os dados mudarem. Invoque o retorno de chamada de cancelamento de inscrição devolvido para parar de receber atualizações. Consulte Recuperar dados na web para obter mais detalhes.

Um evento onValue acionará uma vez com os dados iniciais armazenados neste local e, em seguida, acionará novamente cada vez que os dados mudarem. O DataSnapshot passado para o retorno de chamada será para o local em que on() foi chamado. Não será acionado até que todo o conteúdo tenha sido sincronizado. Se o local não tiver dados, ele será acionado com um DataSnapshot vazio ( val() retornará null ).

Assinatura:

export declare function onValue(query: Query, callback: (snapshot: DataSnapshot) => unknown, cancelCallback?: (error: Error) => unknown): Unsubscribe;

Parâmetros

Retorna:

Cancelar subscrição

Uma função que pode ser invocada para remover o ouvinte.

onvalue (consulta, retorno de chamada, opções)

Ouve alterações de dados em um local específico.

Esta é a principal maneira de ler dados de um banco de dados. Seu retorno de chamada será acionado para os dados iniciais e novamente sempre que os dados mudarem. Invoque o retorno de chamada de cancelamento de inscrição devolvido para parar de receber atualizações. Consulte Recuperar dados na web para obter mais detalhes.

Um evento onValue acionará uma vez com os dados iniciais armazenados neste local e, em seguida, acionará novamente cada vez que os dados mudarem. O DataSnapshot passado para o retorno de chamada será para o local em que on() foi chamado. Não será acionado até que todo o conteúdo tenha sido sincronizado. Se o local não tiver dados, ele será acionado com um DataSnapshot vazio ( val() retornará null ).

Assinatura:

export declare function onValue(query: Query, callback: (snapshot: DataSnapshot) => unknown, options: ListenOptions): Unsubscribe;

Parâmetros

Retorna:

Cancelar subscrição

Uma função que pode ser invocada para remover o ouvinte.

onvalue (consulta, retorno de chamada, cancelCallback, opções)

Ouve alterações de dados em um local específico.

Esta é a principal maneira de ler dados de um banco de dados. Seu retorno de chamada será acionado para os dados iniciais e novamente sempre que os dados mudarem. Invoque o retorno de chamada de cancelamento de inscrição devolvido para parar de receber atualizações. Consulte Recuperar dados na web para obter mais detalhes.

Um evento onValue acionará uma vez com os dados iniciais armazenados neste local e, em seguida, acionará novamente cada vez que os dados mudarem. O DataSnapshot passado para o retorno de chamada será para o local em que on() foi chamado. Não será acionado até que todo o conteúdo tenha sido sincronizado. Se o local não tiver dados, ele será acionado com um DataSnapshot vazio ( val() retornará null ).

Assinatura:

export declare function onValue(query: Query, callback: (snapshot: DataSnapshot) => unknown, cancelCallback: (error: Error) => unknown, options: ListenOptions): Unsubscribe;

Parâmetros

Retorna:

Cancelar subscrição

Uma função que pode ser invocada para remover o ouvinte.

Consulta (consulta, Queryconstraints)

Cria uma nova instância imutável de Query que é estendida para incluir também restrições de consulta adicionais.

Assinatura:

export declare function query(query: Query, ...queryConstraints: QueryConstraint[]): Query;

Parâmetros

Retorna:

Consulta

Exceções

if any of the provided query constraints cannot be combined with the existing or new constraints.

function(ref, ...)

onDisconnect(ref)

Returns an OnDisconnect object - see Enabling Offline Capabilities in JavaScript for more information on how to use it.

Assinatura:

export declare function onDisconnect(ref: DatabaseReference): OnDisconnect;

Parâmetros

Retorna:

OnDisconnect

remove(ref)

Removes the data at this Database location.

Any data at child locations will also be deleted.

The effect of the remove will be visible immediately and the corresponding event 'value' will be triggered. Synchronization of the remove to the Firebase servers will also be started, and the returned Promise will resolve when complete. If provided, the onComplete callback will be called asynchronously after synchronization has finished.

Assinatura:

export declare function remove(ref: DatabaseReference): Promise<void>;

Parâmetros

Retorna:

Promise<void>

Resolves when remove on server is complete.

runTransaction(ref, transactionUpdate, options)

Atomically modifies the data at this location.

Atomically modify the data at this location. Unlike a normal set() , which just overwrites the data regardless of its previous value, runTransaction() is used to modify the existing value to a new value, ensuring there are no conflicts with other clients writing to the same location at the same time.

To accomplish this, you pass runTransaction() an update function which is used to transform the current value into a new value. If another client writes to the location before your new value is successfully written, your update function will be called again with the new current value, and the write will be retried. This will happen repeatedly until your write succeeds without conflict or you abort the transaction by not returning a value from your update function.

Assinatura:

export declare function runTransaction(ref: DatabaseReference, transactionUpdate: (currentData: any) => unknown, options?: TransactionOptions): Promise<TransactionResult>;

Parâmetros

Retorna:

Promise< TransactionResult >

A Promise that can optionally be used instead of the onComplete callback to handle success and failure.

set(ref, value)

Writes data to this Database location.

This will overwrite any data at this location and all child locations.

The effect of the write will be visible immediately, and the corresponding events ("value", "child_added", etc.) will be triggered. Synchronization of the data to the Firebase servers will also be started, and the returned Promise will resolve when complete. If provided, the onComplete callback will be called asynchronously after synchronization has finished.

Passing null for the new value is equivalent to calling remove() ; namely, all data at this location and all child locations will be deleted.

set() will remove any priority stored at this location, so if priority is meant to be preserved, you need to use setWithPriority() instead.

Note that modifying data with set() will cancel any pending transactions at that location, so extreme care should be taken if mixing set() and transaction() to modify the same data.

A single set() will generate a single "value" event at the location where the set() was performed.

Assinatura:

export declare function set(ref: DatabaseReference, value: unknown): Promise<void>;

Parâmetros

Retorna:

Promise<void>

Resolves when write to server is complete.

setPriority(ref, priority)

Sets a priority for the data at this Database location.

Applications need not use priority but can order collections by ordinary properties (see Sorting and filtering data ).

Assinatura:

export declare function setPriority(ref: DatabaseReference, priority: string | number | null): Promise<void>;

Parâmetros

Retorna:

Promise<void>

Resolves when write to server is complete.

setWithPriority(ref, value, priority)

Writes data the Database location. Like set() but also specifies the priority for that data.

Applications need not use priority but can order collections by ordinary properties (see Sorting and filtering data ).

Assinatura:

export declare function setWithPriority(ref: DatabaseReference, value: unknown, priority: string | number | null): Promise<void>;

Parâmetros

Retorna:

Promise<void>

Resolves when write to server is complete.

update(ref, values)

Writes multiple values to the Database at once.

The values argument contains multiple property-value pairs that will be written to the Database together. Each child property can either be a simple property (for example, "name") or a relative path (for example, "name/first") from the current location to the data to update.

As opposed to the set() method, update() can be use to selectively update only the referenced properties at the current location (instead of replacing all the child properties at the current location).

The effect of the write will be visible immediately, and the corresponding events ('value', 'child_added', etc.) will be triggered. Synchronization of the data to the Firebase servers will also be started, and the returned Promise will resolve when complete. If provided, the onComplete callback will be called asynchronously after synchronization has finished.

A single update() will generate a single "value" event at the location where the update() was performed, regardless of how many children were modified.

Note that modifying data with update() will cancel any pending transactions at that location, so extreme care should be taken if mixing update() and transaction() to modify the same data.

Passing null to update() will remove the data at this location.

See Introducing multi-location updates and more .

Assinatura:

export declare function update(ref: DatabaseReference, values: object): Promise<void>;

Parâmetros

Retorna:

Promise<void>

Resolves when update on server is complete.

function(value, ...)

endAt(value, key)

Creates a QueryConstraint with the specified ending point.

Using startAt() , startAfter() , endBefore() , endAt() and equalTo() allows you to choose arbitrary starting and ending points for your queries.

The ending point is inclusive, so children with exactly the specified value will be included in the query. The optional key argument can be used to further limit the range of the query. If it is specified, then children that have exactly the specified value must also have a key name less than or equal to the specified key.

You can read more about endAt() in Filtering data .

Assinatura:

export declare function endAt(value: number | string | boolean | null, key?: string): QueryConstraint;

Parâmetros

Retorna:

QueryConstraint

endBefore(value, key)

Creates a QueryConstraint with the specified ending point (exclusive).

Using startAt() , startAfter() , endBefore() , endAt() and equalTo() allows you to choose arbitrary starting and ending points for your queries.

The ending point is exclusive. If only a value is provided, children with a value less than the specified value will be included in the query. If a key is specified, then children must have a value less than or equal to the specified value and a key name less than the specified key.

Assinatura:

export declare function endBefore(value: number | string | boolean | null, key?: string): QueryConstraint;

Parâmetros

Retorna:

QueryConstraint

equalTo(value, key)

Creates a QueryConstraint that includes children that match the specified value.

Using startAt() , startAfter() , endBefore() , endAt() and equalTo() allows you to choose arbitrary starting and ending points for your queries.

The optional key argument can be used to further limit the range of the query. If it is specified, then children that have exactly the specified value must also have exactly the specified key as their key name. This can be used to filter result sets with many matches for the same value.

You can read more about equalTo() in Filtering data .

Assinatura:

export declare function equalTo(value: number | string | boolean | null, key?: string): QueryConstraint;

Parâmetros

Retorna:

QueryConstraint

startAfter(value, key)

Creates a QueryConstraint with the specified starting point (exclusive).

Using startAt() , startAfter() , endBefore() , endAt() and equalTo() allows you to choose arbitrary starting and ending points for your queries.

The starting point is exclusive. If only a value is provided, children with a value greater than the specified value will be included in the query. If a key is specified, then children must have a value greater than or equal to the specified value and aa key name greater than the specified key.

Assinatura:

export declare function startAfter(value: number | string | boolean | null, key?: string): QueryConstraint;

Parâmetros

Retorna:

QueryConstraint

startAt(value, key)

Creates a QueryConstraint with the specified starting point.

Using startAt() , startAfter() , endBefore() , endAt() and equalTo() allows you to choose arbitrary starting and ending points for your queries.

The starting point is inclusive, so children with exactly the specified value will be included in the query. The optional key argument can be used to further limit the range of the query. If it is specified, then children that have exactly the specified value must also have a key name greater than or equal to the specified key.

You can read more about startAt() in Filtering data .

Assinatura:

export declare function startAt(value?: number | string | boolean | null, key?: string): QueryConstraint;

Parâmetros

Retorna:

QueryConstraint

Tipo de evento

One of the following strings: "value", "child_added", "child_changed", "child_removed", or "child_moved."

Assinatura:

export declare type EventType = 'value' | 'child_added' | 'child_changed' | 'child_moved' | 'child_removed';

QueryConstraintType

Describes the different query constraints available in this SDK.

Assinatura:

export declare type QueryConstraintType = 'endAt' | 'endBefore' | 'startAt' | 'startAfter' | 'limitToFirst' | 'limitToLast' | 'orderByChild' | 'orderByKey' | 'orderByPriority' | 'orderByValue' | 'equalTo';

Cancelar subscrição

A callback that can invoked to remove a listener.

Assinatura:

export declare type Unsubscribe = () => void;