database package

Base de données en temps réel Firebase

Les fonctions

Fonction Description
fonction(application, ...)
getDatabase (application, URL) Renvoie l'instance du SDK de base de données en temps réel associé à la FirebaseApp fournie. . Initialise une nouvelle instance avec les paramètres par défaut si aucune instance n'existe ou si l'instance existante utilise une URL de base de données personnalisée.
fonction (base de données, ...)
connectDatabaseEmulator (base de données, hôte, port, options) Modifiez l'instance fournie pour communiquer avec l'émulateur de base de données en temps réel.

Remarque : Cette méthode doit être appelée avant d'effectuer toute autre opération.

aller hors ligne (base de données) Se déconnecte du serveur (toutes les opérations de base de données seront effectuées hors ligne). Le client maintient automatiquement une connexion persistante au serveur de base de données, qui restera actif indéfiniment et se reconnectera une fois déconnecté. Cependant, les méthodes goOffline() et goOnline() peuvent être utilisées pour contrôler la connexion client dans les cas où une connexion persistante n'est pas souhaitable. Lorsqu'il est hors ligne, le client ne recevra plus de mises à jour de données de la base de données. Cependant, toutes les opérations de base de données effectuées localement continueront à déclencher immédiatement des événements, permettant à votre application de continuer à se comporter normalement. De plus, chaque opération effectuée localement sera automatiquement mise en file d'attente et réessayée lors de la reconnexion au serveur de base de données. Pour vous reconnecter à la base de données et commencer à recevoir des événements distants, consultez goOnline() .
aller en ligne (db) Se reconnecte au serveur et synchronise l'état de la base de données hors ligne avec l'état du serveur. Cette méthode doit être utilisée après avoir désactivé la connexion active avec goOffline() . Une fois reconnecté, le client transmettra les données appropriées et déclenchera les événements appropriés afin que votre client « rattrape » automatiquement son retard.
ref (base de données, chemin) Renvoie une Reference représentant l'emplacement dans la base de données correspondant au chemin fourni. Si aucun chemin n'est fourni, la Reference pointera vers la racine de la base de données.
refFromURL (base de données, URL) Renvoie une Reference représentant l'emplacement dans la base de données correspondant à l'URL Firebase fournie. Une exception est levée si l'URL n'est pas une URL de base de données Firebase valide ou si elle possède un domaine différent de celui de l'instance Database actuelle. Notez que tous les paramètres de requête ( orderBy , limitToLast , etc.) sont ignorés et ne sont pas appliqués à la Reference renvoyée.
fonction()
forceLongPolling() Forcez l’utilisation de longPolling au lieu des websockets. Ceci sera ignoré si le protocole websocket est utilisé dans databaseURL.
forceWebSockets() Forcez l’utilisation de websockets au lieu de longPolling.
commandeParClé() Crée un nouveau QueryConstraint qui classe par clé. Trie les résultats d'une requête selon leurs valeurs clés (ascendantes). Vous pouvez en savoir plus sur orderByKey() dans Trier les données .
commandeByPriority() Crée un nouveau QueryConstraint qui classe par priorité. Les applications n'ont pas besoin d'utiliser la priorité mais peuvent trier les collections par propriétés ordinaires (voir Trier les données pour des alternatives à la priorité.
commandeParValeur() Crée un nouveau QueryConstraint qui classe par valeur. Si les enfants d'une requête sont tous des valeurs scalaires (chaîne, nombre ou booléen), vous pouvez trier les résultats selon leurs valeurs (croissantes). Vous pouvez en savoir plus sur orderByValue() dans Trier les données .
serveurTimestamp() Renvoie une valeur d'espace réservé pour remplir automatiquement l'horodatage actuel (temps écoulé depuis l'époque Unix, en millisecondes), tel que déterminé par les serveurs Firebase.
fonction(delta, ...)
incrément (delta) Renvoie une valeur d'espace réservé qui peut être utilisée pour incrémenter atomiquement la valeur actuelle de la base de données du delta fourni.
fonction (activée, ...)
activateLogging (activé, persistant) Enregistre les informations de débogage sur la console.
fonction(limite, ...)
limiteVersPremier(limite) Crée un nouveau QueryConstraint qui est limité au premier nombre spécifique d'enfants. La méthode limitToFirst() est utilisée pour définir un nombre maximum d'enfants à synchroniser pour un rappel donné. Si nous fixons une limite de 100, nous ne recevrons initialement que jusqu'à 100 événements child_added . Si nous avons moins de 100 messages stockés dans notre base de données, un événement child_added se déclenchera pour chaque message. Cependant, si nous avons plus de 100 messages, nous ne recevrons un événement child_added que pour les 100 premiers messages commandés. Au fur et à mesure que les éléments changent, nous recevrons des événements child_removed pour chaque élément qui disparaît de la liste active afin que le nombre total reste à 100. Vous pouvez en savoir plus sur limitToFirst() dans Filtrage des données .
limiteVersDernier(limite) Crée un nouveau QueryConstraint limité pour renvoyer uniquement le dernier nombre d'enfants spécifié. La méthode limitToLast() est utilisée pour définir un nombre maximum d'enfants à synchroniser pour un rappel donné. Si nous fixons une limite de 100, nous ne recevrons initialement que jusqu'à 100 événements child_added . Si nous avons moins de 100 messages stockés dans notre base de données, un événement child_added se déclenchera pour chaque message. Cependant, si nous avons plus de 100 messages, nous ne recevrons un événement child_added que pour les 100 derniers messages commandés. Au fur et à mesure que les éléments changent, nous recevrons des événements child_removed pour chaque élément qui disparaît de la liste active afin que le nombre total reste à 100. Vous pouvez en savoir plus sur limitToLast() dans Filtrage des données .
fonction (enregistreur, ...)
activerLogging (enregistreur) Enregistre les informations de débogage sur la console.
fonction(parent, ...)
enfant (parent, chemin) Obtient une Reference pour l'emplacement au chemin relatif spécifié. Le chemin relatif peut être soit un simple nom d'enfant (par exemple, « ada »), soit un chemin plus profond séparé par des barres obliques (par exemple, « ada/name/first »).
pousser (parent, valeur) Génère un nouvel emplacement enfant à l'aide d'une clé unique et renvoie sa Reference . Il s'agit du modèle le plus courant pour ajouter des données à une collection d'éléments. Si vous fournissez une valeur à push() , la valeur est écrite à l'emplacement généré. Si vous ne transmettez pas de valeur, rien n'est écrit dans la base de données et l'enfant reste vide (mais vous pouvez utiliser la Reference ailleurs). Les clés uniques générées par push() sont classées par heure actuelle, de sorte que la liste d'éléments résultante est triée chronologiquement. Les clés sont également conçues pour être indevinables (elles contiennent 72 bits aléatoires d’entropie). Voir Ajouter à une liste de données . Découvrez les 2 ^ 120 façons de garantir des identifiants uniques .
fonction(chemin, ...)
commandeParEnfant(chemin) Crée un nouveau QueryConstraint qui classe en fonction de la clé enfant spécifiée. Les requêtes ne peuvent être commandées que par une seule clé à la fois. Appeler orderByChild() plusieurs fois sur la même requête est une erreur. Les requêtes Firebase vous permettent de trier vos données par n'importe quelle clé enfant à la volée. Cependant, si vous savez à l'avance quels seront vos index, vous pouvez les définir via la règle .indexOn dans vos Règles de Sécurité pour de meilleures performances. Consultez la règle https://firebase.google.com/docs/database/security/indexing-data pour plus d'informations. Vous pouvez en savoir plus sur orderByChild() dans Trier les données .
fonction(requête, ...)
obtenir (requête) Obtient le résultat le plus récent pour cette requête.
off (requête, type d'événement, rappel) Détache un rappel précédemment attaché à l'écouteur on () ( onValue , onChildAdded ) correspondant. Remarque : il ne s'agit pas de la méthode recommandée pour supprimer un écouteur. Au lieu de cela, veuillez utiliser la fonction de rappel renvoyée par les rappels on respectifs. Détachez un rappel précédemment attaché avec on*() . L'appel de off() sur un écouteur parent ne supprimera pas automatiquement les écouteurs enregistrés sur les nœuds enfants, off() doit également être appelé sur tous les écouteurs enfants pour supprimer le rappel. Si aucun rappel n'est spécifié, tous les rappels pour le type d'événement spécifié seront supprimés. De même, si aucun eventType n’est spécifié, tous les rappels pour la Reference seront supprimés. Les auditeurs individuels peuvent également être supprimés en appelant leurs rappels de désabonnement.
onChildAdded (requête, rappel, CancelCallback) Écoute les modifications de données à un emplacement particulier. Il s'agit du principal moyen de lire les données d'une base de données. Votre rappel sera déclenché pour les données initiales et à nouveau chaque fois que les données changent. Appelez le rappel de désabonnement renvoyé pour ne plus recevoir de mises à jour. Voir Récupérer des données sur le Web pour plus de détails. Un événement onChildAdded sera déclenché une fois pour chaque enfant initial à cet emplacement, et il sera déclenché à nouveau chaque fois qu'un nouvel enfant est ajouté. Le DataSnapshot transmis dans le rappel reflétera les données de l'enfant concerné. À des fins de classement, un deuxième argument lui est transmis qui est une chaîne contenant la clé de l'enfant frère précédent par ordre de tri, ou null s'il s'agit du premier enfant.
onChildAdded (requête, rappel, options) Écoute les modifications de données à un emplacement particulier. Il s'agit du principal moyen de lire les données d'une base de données. Votre rappel sera déclenché pour les données initiales et à nouveau chaque fois que les données changent. Appelez le rappel de désabonnement renvoyé pour ne plus recevoir de mises à jour. Voir Récupérer des données sur le Web pour plus de détails. Un événement onChildAdded sera déclenché une fois pour chaque enfant initial à cet emplacement, et il sera déclenché à nouveau chaque fois qu'un nouvel enfant est ajouté. Le DataSnapshot transmis dans le rappel reflétera les données de l'enfant concerné. À des fins de classement, un deuxième argument lui est transmis qui est une chaîne contenant la clé de l'enfant frère précédent par ordre de tri, ou null s'il s'agit du premier enfant.
onChildAdded (requête, rappel, CancelCallback, options) Écoute les modifications de données à un emplacement particulier. Il s'agit du principal moyen de lire les données d'une base de données. Votre rappel sera déclenché pour les données initiales et à nouveau chaque fois que les données changent. Appelez le rappel de désabonnement renvoyé pour ne plus recevoir de mises à jour. Voir Récupérer des données sur le Web pour plus de détails. Un événement onChildAdded sera déclenché une fois pour chaque enfant initial à cet emplacement, et il sera déclenché à nouveau chaque fois qu'un nouvel enfant est ajouté. Le DataSnapshot transmis dans le rappel reflétera les données de l'enfant concerné. À des fins de classement, un deuxième argument lui est transmis qui est une chaîne contenant la clé de l'enfant frère précédent par ordre de tri, ou null s'il s'agit du premier enfant.
onChildChanged (requête, rappel, cancelCallback) Écoute les modifications de données à un emplacement particulier. Il s'agit du principal moyen de lire les données d'une base de données. Votre rappel sera déclenché pour les données initiales et à nouveau chaque fois que les données changent. Appelez le rappel de désabonnement renvoyé pour ne plus recevoir de mises à jour. Voir Récupérer des données sur le Web pour plus de détails. Un événement onChildChanged sera déclenché lorsque les données stockées chez un enfant (ou l'un de ses descendants) changent. Notez qu'un seul événement child_changed peut représenter plusieurs modifications apportées à l'enfant. Le DataSnapshot passé au rappel contiendra le nouveau contenu enfant. À des fins de classement, le rappel reçoit également un deuxième argument qui est une chaîne contenant la clé de l'enfant frère précédent par ordre de tri, ou null s'il s'agit du premier enfant.
onChildChanged (requête, rappel, options) Écoute les modifications de données à un emplacement particulier. Il s'agit du principal moyen de lire les données d'une base de données. Votre rappel sera déclenché pour les données initiales et à nouveau chaque fois que les données changent. Appelez le rappel de désabonnement renvoyé pour ne plus recevoir de mises à jour. Voir Récupérer des données sur le Web pour plus de détails. Un événement onChildChanged sera déclenché lorsque les données stockées chez un enfant (ou l'un de ses descendants) changent. Notez qu'un seul événement child_changed peut représenter plusieurs modifications apportées à l'enfant. Le DataSnapshot passé au rappel contiendra le nouveau contenu enfant. À des fins de classement, le rappel reçoit également un deuxième argument qui est une chaîne contenant la clé de l'enfant frère précédent par ordre de tri, ou null s'il s'agit du premier enfant.
onChildChanged (requête, rappel, CancelCallback, options) Écoute les modifications de données à un emplacement particulier. Il s'agit du principal moyen de lire les données d'une base de données. Votre rappel sera déclenché pour les données initiales et à nouveau chaque fois que les données changent. Appelez le rappel de désabonnement renvoyé pour ne plus recevoir de mises à jour. Voir Récupérer des données sur le Web pour plus de détails. Un événement onChildChanged sera déclenché lorsque les données stockées chez un enfant (ou l'un de ses descendants) changent. Notez qu'un seul événement child_changed peut représenter plusieurs modifications apportées à l'enfant. Le DataSnapshot passé au rappel contiendra le nouveau contenu enfant. À des fins de classement, le rappel reçoit également un deuxième argument qui est une chaîne contenant la clé de l'enfant frère précédent par ordre de tri, ou null s'il s'agit du premier enfant.
onChildMoved (requête, rappel, annulation de rappel) Écoute les modifications de données à un emplacement particulier. Il s'agit du principal moyen de lire les données d'une base de données. Votre rappel sera déclenché pour les données initiales et à nouveau chaque fois que les données changent. Appelez le rappel de désabonnement renvoyé pour ne plus recevoir de mises à jour. Voir Récupérer des données sur le Web pour plus de détails. Un événement onChildMoved sera déclenché lorsque l'ordre de tri d'un enfant change de telle sorte que sa position par rapport à ses frères et sœurs change. Le DataSnapshot transmis au rappel concernera les données de l'enfant qui a été déplacé. Il reçoit également un deuxième argument qui est une chaîne contenant la clé de l'enfant frère précédent par ordre de tri, ou null s'il s'agit du premier enfant.
onChildMoved (requête, rappel, options) Écoute les modifications de données à un emplacement particulier. Il s'agit du principal moyen de lire les données d'une base de données. Votre rappel sera déclenché pour les données initiales et à nouveau chaque fois que les données changent. Appelez le rappel de désabonnement renvoyé pour ne plus recevoir de mises à jour. Voir Récupérer des données sur le Web pour plus de détails. Un événement onChildMoved sera déclenché lorsque l'ordre de tri d'un enfant change de telle sorte que sa position par rapport à ses frères et sœurs change. Le DataSnapshot transmis au rappel concernera les données de l'enfant qui a été déplacé. Il reçoit également un deuxième argument qui est une chaîne contenant la clé de l'enfant frère précédent par ordre de tri, ou null s'il s'agit du premier enfant.
onChildMoved (requête, rappel, CancelCallback, options) Écoute les modifications de données à un emplacement particulier. Il s'agit du principal moyen de lire les données d'une base de données. Votre rappel sera déclenché pour les données initiales et à nouveau chaque fois que les données changent. Appelez le rappel de désabonnement renvoyé pour ne plus recevoir de mises à jour. Voir Récupérer des données sur le Web pour plus de détails. Un événement onChildMoved sera déclenché lorsque l'ordre de tri d'un enfant change de telle sorte que sa position par rapport à ses frères et sœurs change. Le DataSnapshot transmis au rappel concernera les données de l'enfant qui a été déplacé. Il reçoit également un deuxième argument qui est une chaîne contenant la clé de l'enfant frère précédent par ordre de tri, ou null s'il s'agit du premier enfant.
onChildRemoved (requête, rappel, CancelCallback) Écoute les modifications de données à un emplacement particulier. Il s'agit du principal moyen de lire les données d'une base de données. Votre rappel sera déclenché pour les données initiales et à nouveau chaque fois que les données changent. Appelez le rappel de désabonnement renvoyé pour ne plus recevoir de mises à jour. Voir Récupérer des données sur le Web pour plus de détails. Un événement onChildRemoved sera déclenché une fois à chaque fois qu'un enfant est supprimé. Le DataSnapshot transmis dans le rappel sera les anciennes données de l'enfant qui a été supprimé. Un enfant sera retiré lorsque : - un client appelle explicitement remove() sur cet enfant ou l'un de ses ancêtres - un client appelle set(null) sur cet enfant ou l'un de ses ancêtres - cet enfant a tous ses enfants supprimés - il y a une requête en vigueur qui maintenant filtre l'enfant (car son ordre de tri a changé ou la limite maximale a été atteinte)
onChildRemoved (requête, rappel, options) Écoute les modifications de données à un emplacement particulier. Il s'agit du principal moyen de lire les données d'une base de données. Votre rappel sera déclenché pour les données initiales et à nouveau chaque fois que les données changent. Appelez le rappel de désabonnement renvoyé pour ne plus recevoir de mises à jour. Voir Récupérer des données sur le Web pour plus de détails. Un événement onChildRemoved sera déclenché une fois à chaque fois qu'un enfant est supprimé. Le DataSnapshot transmis dans le rappel sera les anciennes données de l'enfant qui a été supprimé. Un enfant sera retiré lorsque : - un client appelle explicitement remove() sur cet enfant ou l'un de ses ancêtres - un client appelle set(null) sur cet enfant ou l'un de ses ancêtres - cet enfant a tous ses enfants supprimés - il y a une requête en vigueur qui maintenant filtre l'enfant (car son ordre de tri a changé ou la limite maximale a été atteinte)
onChildRemoved (requête, rappel, CancelCallback, options) Écoute les modifications de données à un emplacement particulier. Il s'agit du principal moyen de lire les données d'une base de données. Votre rappel sera déclenché pour les données initiales et à nouveau chaque fois que les données changent. Appelez le rappel de désabonnement renvoyé pour ne plus recevoir de mises à jour. Voir Récupérer des données sur le Web pour plus de détails. Un événement onChildRemoved sera déclenché une fois à chaque fois qu'un enfant est supprimé. Le DataSnapshot transmis dans le rappel sera les anciennes données de l'enfant qui a été supprimé. Un enfant sera retiré lorsque : - un client appelle explicitement remove() sur cet enfant ou l'un de ses ancêtres - un client appelle set(null) sur cet enfant ou l'un de ses ancêtres - cet enfant a tous ses enfants supprimés - il y a une requête en vigueur qui maintenant filtre l'enfant (car son ordre de tri a changé ou la limite maximale a été atteinte)
onValue (requête, rappel, CancelCallback) Écoute les modifications de données à un emplacement particulier. Il s'agit du principal moyen de lire les données d'une base de données. Votre rappel sera déclenché pour les données initiales et à nouveau chaque fois que les données changent. Appelez le rappel de désabonnement renvoyé pour ne plus recevoir de mises à jour. Voir Récupérer des données sur le Web pour plus de détails. Un événement onValue se déclenchera une fois avec les données initiales stockées à cet emplacement, puis se déclenchera à nouveau chaque fois que les données changeront. Le DataSnapshot transmis au rappel concernera l'emplacement auquel on() a été appelé. Il ne se déclenchera pas tant que l'intégralité du contenu n'aura pas été synchronisée. Si l'emplacement n'a pas de données, il sera déclenché avec un DataSnapshot vide ( val() renverra null ).
onValue (requête, rappel, options) Écoute les modifications de données à un emplacement particulier. Il s'agit du principal moyen de lire les données d'une base de données. Votre rappel sera déclenché pour les données initiales et à nouveau chaque fois que les données changent. Appelez le rappel de désabonnement renvoyé pour ne plus recevoir de mises à jour. Voir Récupérer des données sur le Web pour plus de détails. Un événement onValue se déclenchera une fois avec les données initiales stockées à cet emplacement, puis se déclenchera à nouveau chaque fois que les données changeront. Le DataSnapshot transmis au rappel concernera l'emplacement auquel on() a été appelé. Il ne se déclenchera pas tant que l'intégralité du contenu n'aura pas été synchronisée. Si l'emplacement n'a pas de données, il sera déclenché avec un DataSnapshot vide ( val() renverra null ).
onValue (requête, rappel, CancelCallback, options) Écoute les modifications de données à un emplacement particulier. Il s'agit du principal moyen de lire les données d'une base de données. Votre rappel sera déclenché pour les données initiales et à nouveau chaque fois que les données changent. Appelez le rappel de désabonnement renvoyé pour ne plus recevoir de mises à jour. Voir Récupérer des données sur le Web pour plus de détails. Un événement onValue se déclenchera une fois avec les données initiales stockées à cet emplacement, puis se déclenchera à nouveau chaque fois que les données changeront. Le DataSnapshot transmis au rappel concernera l'emplacement auquel on() a été appelé. Il ne se déclenchera pas tant que l'intégralité du contenu n'aura pas été synchronisée. Si l'emplacement n'a pas de données, il sera déclenché avec un DataSnapshot vide ( val() renverra null ).
requête (requête, requêteConstraints) Crée une nouvelle instance immuable de Query qui est étendue pour inclure également des contraintes de requête supplémentaires.
fonction(réf, ...)
onDisconnect (réf) Renvoie un objet OnDisconnect - voir Activation des fonctionnalités hors ligne dans JavaScript pour plus d'informations sur la façon de l'utiliser.
supprimer (réf) Supprime les données à cet emplacement de base de données. Toutes les données des emplacements enfants seront également supprimées. L'effet de la suppression sera visible immédiatement et l'événement « valeur » correspondant sera déclenché. La synchronisation de la suppression avec les serveurs Firebase sera également lancée et la promesse renvoyée sera résolue une fois terminée. S'il est fourni, le rappel onComplete sera appelé de manière asynchrone une fois la synchronisation terminée.
runTransaction (réf, transactionUpdate, options) Modifie atomiquement les données à cet emplacement. Modifiez atomiquement les données à cet emplacement. Contrairement à un set() normal, qui écrase simplement les données quelle que soit leur valeur précédente, runTransaction() est utilisé pour modifier la valeur existante en une nouvelle valeur, garantissant ainsi l'absence de conflits avec d'autres clients écrivant au même emplacement en même temps. . Pour ce faire, vous transmettez runTransaction() une fonction de mise à jour qui est utilisée pour transformer la valeur actuelle en une nouvelle valeur. Si un autre client écrit à l'emplacement avant que votre nouvelle valeur ne soit écrite avec succès, votre fonction de mise à jour sera à nouveau appelée avec la nouvelle valeur actuelle et l'écriture sera réessayée. Cela se produira à plusieurs reprises jusqu'à ce que votre écriture réussisse sans conflit ou que vous abandonniez la transaction en ne renvoyant pas de valeur de votre fonction de mise à jour. Remarque : La modification des données avec set() annulera toutes les transactions en attente à cet emplacement. Il convient donc d'être extrêmement prudent si vous mélangez set() et runTransaction() pour mettre à jour les mêmes données. Remarque : Lorsque vous utilisez des transactions avec des règles de sécurité et Firebase en place, sachez qu'un client a besoin d'un accès .read en plus de l'accès .write pour effectuer une transaction. En effet, la nature des transactions côté client oblige le client à lire les données afin de les mettre à jour de manière transactionnelle.
set(réf, valeur) Écrit des données dans cet emplacement de base de données. Cela écrasera toutes les données de cet emplacement et de tous les emplacements enfants. L'effet de l'écriture sera visible immédiatement, et les événements correspondants ("value", "child_added", etc.) seront déclenchés. La synchronisation des données avec les serveurs Firebase sera également lancée et la promesse renvoyée sera résolue une fois terminée. S'il est fourni, le rappel onComplete sera appelé de manière asynchrone une fois la synchronisation terminée. Passer null pour la nouvelle valeur équivaut à appeler remove() ; à savoir, toutes les données de cet emplacement et de tous les emplacements enfants seront supprimées. set() supprimera toute priorité stockée à cet emplacement, donc si la priorité doit être préservée, vous devez utiliser setWithPriority() à la place. Notez que la modification des données avec set() annulera toutes les transactions en attente à cet emplacement, il convient donc d'être extrêmement prudent si vous mélangez set() et transaction() pour modifier les mêmes données. Un seul set() générera un seul événement « valeur » à l’emplacement où le set() a été effectué.
setPriority(réf, priorité) Définit une priorité pour les données à cet emplacement de base de données. Les applications n'ont pas besoin d'utiliser la priorité mais peuvent trier les collections par propriétés ordinaires (voir Tri et filtrage des données ).
setWithPriority(réf, valeur, priorité) Écrit les données à l'emplacement de la base de données. Comme set() mais spécifie également la priorité de ces données. Les applications n'ont pas besoin d'utiliser la priorité mais peuvent trier les collections par propriétés ordinaires (voir Tri et filtrage des données ).
mise à jour (réf, valeurs) Écrit plusieurs valeurs dans la base de données à la fois. L’argument values contient plusieurs paires propriété-valeur qui seront écrites ensemble dans la base de données. Chaque propriété enfant peut être soit une propriété simple (par exemple, « nom »), soit un chemin relatif (par exemple, « nom/prénom ») depuis l'emplacement actuel vers les données à mettre à jour. Contrairement à la méthode set() , update() peut être utilisée pour mettre à jour de manière sélective uniquement les propriétés référencées à l'emplacement actuel (au lieu de remplacer toutes les propriétés enfants à l'emplacement actuel). L'effet de l'écriture sera visible immédiatement et les événements correspondants (« valeur », « enfant_ajouté », etc.) seront déclenchés. La synchronisation des données avec les serveurs Firebase sera également lancée et la promesse renvoyée sera résolue une fois terminée. S'il est fourni, le rappel onComplete sera appelé de manière asynchrone une fois la synchronisation terminée. Une seule update() générera un seul événement « valeur » à l'emplacement où la update() a été effectuée, quel que soit le nombre d'enfants modifiés. Notez que la modification des données avec update() annulera toutes les transactions en attente à cet emplacement, il convient donc d'être extrêmement prudent si vous mélangez update() et transaction() pour modifier les mêmes données. Passer null à update() supprimera les données à cet emplacement. Voir Présentation des mises à jour multi-emplacements et plus encore .
fonction(valeur, ...)
endAt (valeur, clé) Crée un QueryConstraint avec le point de fin spécifié. L'utilisation startAt() , startAfter() , endBefore() , endAt() et equalTo() vous permet de choisir des points de début et de fin arbitraires pour vos requêtes. Le point final est inclusif, donc les enfants ayant exactement la valeur spécifiée seront inclus dans la requête. L'argument key facultatif peut être utilisé pour limiter davantage la plage de la requête. S'il est spécifié, les enfants qui ont exactement la valeur spécifiée doivent également avoir un nom de clé inférieur ou égal à la clé spécifiée. Vous pouvez en savoir plus sur endAt() dans Filtrage des données .
endBefore (valeur, clé) Crée un QueryConstraint avec le point de fin spécifié (exclusif). L'utilisation startAt() , startAfter() , endBefore() , endAt() et equalTo() vous permet de choisir des points de début et de fin arbitraires pour vos requêtes. Le point final est exclusif. Si seule une valeur est fournie, les enfants avec une valeur inférieure à la valeur spécifiée seront inclus dans la requête. Si une clé est spécifiée, les enfants doivent avoir une valeur inférieure ou égale à la valeur spécifiée et un nom de clé inférieur à la clé spécifiée.
égal à (valeur, clé) Crée un QueryConstraint qui inclut les enfants qui correspondent à la valeur spécifiée. L'utilisation startAt() , startAfter() , endBefore() , endAt() et equalTo() vous permet de choisir des points de début et de fin arbitraires pour vos requêtes. L'argument key facultatif peut être utilisé pour limiter davantage la plage de la requête. Si cela est spécifié, alors les enfants qui ont exactement la valeur spécifiée doivent également avoir exactement la clé spécifiée comme nom de clé. Cela peut être utilisé pour filtrer les ensembles de résultats avec de nombreuses correspondances pour la même valeur. Vous pouvez en savoir plus sur equalTo() dans Filtrage des données .
startAfter (valeur, clé) Crée un QueryConstraint avec le point de départ spécifié (exclusif). L'utilisation startAt() , startAfter() , endBefore() , endAt() et equalTo() vous permet de choisir des points de début et de fin arbitraires pour vos requêtes. Le point de départ est exclusif. Si seule une valeur est fournie, les enfants dont la valeur est supérieure à la valeur spécifiée seront inclus dans la requête. Si une clé est spécifiée, les enfants doivent avoir une valeur supérieure ou égale à la valeur spécifiée et un nom de clé supérieur à la clé spécifiée.
startAt (valeur, clé) Crée un QueryConstraint avec le point de départ spécifié. L'utilisation startAt() , startAfter() , endBefore() , endAt() et equalTo() vous permet de choisir des points de début et de fin arbitraires pour vos requêtes. Le point de départ est inclusif, donc les enfants ayant exactement la valeur spécifiée seront inclus dans la requête. L'argument key facultatif peut être utilisé pour limiter davantage la plage de la requête. S'il est spécifié, les enfants qui ont exactement la valeur spécifiée doivent également avoir un nom de clé supérieur ou égal à la clé spécifiée. Vous pouvez en savoir plus sur startAt() dans Filtrage des données .

Des classes

Classe Description
Base de données Classe représentant une base de données Firebase Realtime.
Aperçu des données Un DataSnapshot contient des données provenant d'un emplacement de base de données. Chaque fois que vous lisez des données de la base de données, vous recevez les données sous forme de DataSnapshot . Un DataSnapshot est transmis aux rappels d'événements que vous attachez avec on() ou once() . Vous pouvez extraire le contenu de l'instantané en tant qu'objet JavaScript en appelant la méthode val() . Alternativement, vous pouvez accéder à l'instantané en appelant child() pour renvoyer des instantanés enfants (sur lesquels vous pouvez ensuite appeler val() ). Un DataSnapshot est une copie immuable et générée efficacement des données dans un emplacement de base de données. Il ne peut pas être modifié et ne changera jamais (pour modifier des données, vous appelez toujours directement la méthode set() sur une Reference ).
SurDéconnexion La classe onDisconnect vous permet d'écrire ou d'effacer des données lorsque votre client se déconnecte du serveur de base de données. Ces mises à jour se produisent que votre client se déconnecte proprement ou non, vous pouvez donc compter sur elles pour nettoyer les données même si une connexion est interrompue ou si un client plante. La classe onDisconnect est le plus souvent utilisée pour gérer la présence dans les applications où il est utile de détecter le nombre de clients connectés et le moment où d'autres clients se déconnectent. Voir Activation des fonctionnalités hors ligne dans JavaScript pour plus d'informations. Pour éviter les problèmes lorsqu'une connexion est interrompue avant que les requêtes puissent être transférées au serveur de base de données, ces fonctions doivent être appelées avant d'écrire des données. Notez que les opérations onDisconnect ne sont déclenchées qu’une seule fois. Si vous souhaitez qu'une opération se produise à chaque fois qu'une déconnexion se produit, vous devrez rétablir les opérations onDisconnect à chaque fois que vous vous reconnecterez.
Contrainte de requête Une QueryConstraint est utilisée pour restreindre l'ensemble de documents renvoyés par une requête de base de données. Les QueryConstraint sont créés en appelant endAt() , finAvant() , commencer à() , startAfter() , limiteVersPremier() , limiteVersDernier() , commandeParEnfant() , commandeParEnfant() , orderByKey() , orderByPriority() , orderByValue() ou égalTo() et peut ensuite être transmis à query() pour créer une nouvelle instance de requête qui contient également cette QueryConstraint .
Résultat de la transaction Un type pour la valeur de résolution de runTransaction() .

Interfaces

Interface Description
Référence de base de données Une DatabaseReference représente un emplacement spécifique dans votre base de données et peut être utilisée pour lire ou écrire des données dans cet emplacement de base de données. Vous pouvez référencer l'emplacement racine ou enfant dans votre base de données en appelant ref() ou ref("child/path") . L'écriture se fait avec la méthode set() et la lecture peut se faire avec la méthode on*() . Voir https://firebase.google.com/docs/database/web/read-and-write
ItéréDataSnapshot Représente un instantané enfant d’une Reference en cours d’itération. La clé ne sera jamais indéfinie.
Options d'écoute Objets d'options qui peuvent être utilisés pour personnaliser un écouteur.
Requête Une Query trie et filtre les données à un emplacement de base de données afin que seul un sous-ensemble des données enfants soit inclus. Cela peut être utilisé pour classer une collection de données en fonction d'un attribut (par exemple, la taille des dinosaures) ainsi que pour restreindre une grande liste d'éléments (par exemple, des messages de discussion) à un nombre approprié pour la synchronisation avec le client. Les requêtes sont créées en enchaînant une ou plusieurs des méthodes de filtrage définies ici. Tout comme avec un DatabaseReference , vous pouvez recevoir des données d'un Query en utilisant les méthodes on*() . Vous ne recevrez que des événements et DataSnapshot pour le sous-ensemble de données qui correspond à votre requête. Voir https://firebase.google.com/docs/database/web/lists-of-data#sorting_and_filtering_data pour plus d'informations.
ThenableRéférence Une Promise qui peut également servir de DatabaseReference lorsqu'elle est renvoyée par push() . La référence est disponible immédiatement et la Promise est résolue à mesure que l'écriture sur le backend est terminée.
Options de transaction Un objet d'options pour configurer les transactions.

Tapez les alias

Tapez l'alias Description
Type d'événement Une des chaînes suivantes : "value", "child_added", "child_changed", "child_removed" ou "child_moved".
Type de contrainte de requête Décrit les différentes contraintes de requête disponibles dans ce SDK.
Se désabonner Un rappel qui peut être invoqué pour supprimer un écouteur.

fonction(application, ...)

getDatabase (application, URL)

Renvoie l'instance du SDK de base de données en temps réel associé à la FirebaseApp fournie. . Initialise une nouvelle instance avec les paramètres par défaut si aucune instance n'existe ou si l'instance existante utilise une URL de base de données personnalisée.

Signature:

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

Paramètres

Paramètre Taper Description
application FirebaseApp Instance FirebaseApp à laquelle l'instance de base de données en temps réel renvoyée est associée.
URL chaîne L'URL de l'instance de base de données en temps réel à laquelle se connecter. S'il n'est pas fourni, le SDK se connecte à l'instance par défaut de l'application Firebase.

Retour:

Base de données

Instance Database de l’application fournie.

fonction (base de données, ...)

connectDatabaseEmulator (db, hôte, port, options)

Modifiez l'instance fournie pour communiquer avec l'émulateur de base de données en temps réel.

Remarque: Cette méthode doit être appelée avant d'effectuer une autre opération.

Signature:

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

Paramètres

Paramètre Taper Description
base de données Base de données L'instance à modifier.
hôte chaîne L'hôte de l'émulateur (Ex: LocalHost)
port nombre Le port d'émulateur (Ex: 8080)
choix {MockUsertoken ?: EMULATORMOCKTOKINEOPTIONS | chaîne; }

Retour:

vide

Gooffline (DB)

Déconnecte du serveur (toutes les opérations de base de données seront terminées hors ligne).

Le client maintient automatiquement une connexion persistante au serveur de base de données, qui restera actif indéfiniment et reconnectera lorsqu'il est déconnecté. Cependant, les méthodes goOffline() et goOnline() peuvent être utilisées pour contrôler la connexion du client dans les cas où une connexion persistante n'est pas souhaitable.

Bien que hors ligne, le client ne recevra plus de mises à jour de données de la base de données. Cependant, toutes les opérations de base de données effectuées localement continueront de tirer immédiatement des événements, permettant à votre application de continuer à se comporter normalement. De plus, chaque opération effectuée localement sera automatiquement en file d'attente et repris lors de la reconnexion au serveur de base de données.

Pour vous reconnecter à la base de données et commencer à recevoir des événements distants, voir goOnline() .

Signature:

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

Paramètres

Paramètre Taper Description
base de données Base de données L'instance à déconnecter.

Retour:

vide

Goonline (DB)

Se reconnecte avec le serveur et synchronise l'état de la base de données hors ligne avec l'état du serveur.

Cette méthode doit être utilisée après avoir désactivé la connexion active avec goOffline() . Une fois reconnectée, le client transmettra les données appropriées et licenciera les événements appropriés afin que votre client "rattrape" automatiquement ".

Signature:

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

Paramètres

Paramètre Taper Description
base de données Base de données L'instance à reconnecter.

Retour:

vide

ref (db, chemin)

Renvoie une Reference représentant l'emplacement de la base de données correspondant au chemin fourni. Si aucun chemin n'est fourni, la Reference pointera vers la racine de la base de données.

Signature:

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

Paramètres

Paramètre Taper Description
base de données Base de données L'instance de base de données pour obtenir une référence pour.
chemin chaîne Chemin facultatif représentant l'emplacement que la Reference retournée pointera. S'il n'est pas fourni, la Reference retournée pointera vers la racine de la base de données.

Retour:

DatabaseReference

Si un chemin est fourni, une Reference pointant vers le chemin fourni. Sinon, une Reference pointant vers la racine de la base de données.

reffromurl (db, URL)

Renvoie une Reference représentant l'emplacement de la base de données correspondant à l'URL de base de feu fournie.

Une exception est lancée si l'URL n'est pas une URL de base de données Firebase valide ou elle a un domaine différent de l'instance Database actuelle.

Notez que tous les paramètres de requête ( orderBy , limitToLast , etc.) sont ignorés et ne sont pas appliqués à la Reference retournée .

Signature:

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

Paramètres

Paramètre Taper Description
base de données Base de données L'instance de base de données pour obtenir une référence pour.
URL chaîne L'URL de base de feu à laquelle la Reference retournée pointera.

Retour:

DatabaseReference

Une Reference pointant vers l'URL de base de feu fournie.

fonction()

forcelongpolling ()

Forcer l'utilisation du service long au lieu de WebSockets. Cela sera ignoré si le protocole WebSocket est utilisé dans la base de données.

Signature:

export declare function forceLongPolling(): void;

Retour:

vide

ForceWebsockts ()

Forcez l'utilisation de websockets au lieu de faire unpolling à long terme.

Signature:

export declare function forceWebSockets(): void;

Retour:

vide

OrderByKey ()

Crée une nouvelle QueryConstraint qui ordonne par la clé.

Trie les résultats d'une requête par leurs valeurs clés (ascendantes).

Vous pouvez en savoir plus sur orderByKey() dans les données de tri .

Signature:

export declare function orderByKey(): QueryConstraint;

Retour:

Requête

OrderByPriority ()

Crée une nouvelle QueryConstraint qui ordonne par priorité.

Les applications n'ont pas besoin d'utiliser la priorité mais peuvent commander des collections par des propriétés ordinaires (voir les données de tri pour les alternatives à la priorité.

Signature:

export declare function orderByPriority(): QueryConstraint;

Retour:

Requête

OrderByValue ()

Crée une nouvelle QueryConstraint qui ordonne par valeur.

Si les enfants d'une requête sont toutes des valeurs scalaires (chaîne, nombre ou booléen), vous pouvez commander les résultats par leurs valeurs (ascendantes).

Vous pouvez en savoir plus sur orderByValue() dans les données de tri .

Signature:

export declare function orderByValue(): QueryConstraint;

Retour:

Requête

servertimestamp ()

Renvoie une valeur d'espace réservé pour la population automatique de l'horodatage actuel (temps depuis l'époque Unix, en millisecondes) tel que déterminé par les serveurs de base de base.

Signature:

export declare function serverTimestamp(): object;

Retour:

objet

fonction (delta, ...)

incrément (delta)

Renvoie une valeur d'espace réservé qui peut être utilisée pour incrémenter atomiquement la valeur de base de données actuelle par le delta fourni.

Signature:

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

Paramètres

Paramètre Taper Description
delta nombre Le montant pour modifier la valeur actuelle atomiquement.

Retour:

objet

Une valeur d'espace pour modification des données atomiquement côté serveur.

fonction (activé, ...)

activateLogging (activé, persistant)

Journaux de débogage des informations sur la console.

Signature:

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

Paramètres

Paramètre Taper Description
activé booléen Permet la journalisation si true , désactive la journalisation si false .
persistant booléen Se souvient de l'état de journalisation entre les rafraîchissements de page si cela est true .

Retour:

n'importe lequel

fonction (limite, ...)

LimitTofirst (limite)

Crée une nouvelle QueryConstraint si elle est limitée au premier nombre spécifique d'enfants.

La méthode limitToFirst() est utilisée pour définir un nombre maximum d'enfants à synchroniser pour un rappel donné. Si nous fixons une limite de 100, nous ne recevrons initialement que jusqu'à 100 événements child_added . Si nous avons moins de 100 messages stockés dans notre base de données, un événement child_added se déclenchera pour chaque message. Cependant, si nous avons plus de 100 messages, nous ne recevrons un événement child_added que pour les 100 premiers messages commandés. Au fur et à mesure que les éléments changent, nous recevrons des événements child_removed pour chaque élément qui retire de la liste active afin que le nombre total reste à 100.

Vous pouvez en savoir plus sur limitToFirst() dans le filtrage des données .

Signature:

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

Paramètres

Paramètre Taper Description
limite nombre Le nombre maximum de nœuds à inclure dans cette requête.

Retour:

Requête

LimitTolast (limite)

Crée une nouvelle QueryConstraint limitée pour ne remettre que le dernier nombre spécifié d'enfants.

La méthode limitToLast() est utilisée pour définir un nombre maximal d'enfants à synchroniser pour un rappel donné. Si nous fixons une limite de 100, nous ne recevrons initialement que jusqu'à 100 événements child_added . Si nous avons moins de 100 messages stockés dans notre base de données, un événement child_added se déclenchera pour chaque message. Cependant, si nous avons plus de 100 messages, nous ne recevrons un événement child_added que pour les 100 derniers messages commandés. Au fur et à mesure que les éléments changent, nous recevrons des événements child_removed pour chaque élément qui retire de la liste active afin que le nombre total reste à 100.

Vous pouvez en savoir plus sur limitToLast() dans le filtrage des données .

Signature:

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

Paramètres

Paramètre Taper Description
limite nombre Le nombre maximum de nœuds à inclure dans cette requête.

Retour:

Requête

Fonction (Enregistreur, ...)

pertigging (logger)

Journaux de débogage des informations sur la console.

Signature:

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

Paramètres

Paramètre Taper Description
enregistreur (message: chaîne) => inconnu Une fonction de journalisation personnalisée pour contrôler comment les choses sont enregistrées.

Retour:

n'importe lequel

fonction (parent, ...)

Enfant (parent, chemin)

Obtient une Reference pour l'emplacement sur le chemin relatif spécifié.

Le chemin relatif peut être un simple nom d'enfant (par exemple, "ADA") ou un chemin plus profond séparé par Slash (par exemple, "ADA / Name / First").

Signature:

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

Paramètres

Paramètre Taper Description
parent DatabaseReference L'emplacement parent.
chemin chaîne Un chemin relatif de cet emplacement à l'emplacement de l'enfant souhaité.

Retour:

DatabaseReference

L'emplacement enfant spécifié.

push (parent, valeur)

Génère un nouvel emplacement enfant à l'aide d'une clé unique et renvoie sa Reference .

Il s'agit du modèle le plus courant pour ajouter des données à une collecte d'éléments.

Si vous fournissez une valeur à push() , la valeur est écrite à l'emplacement généré. Si vous ne transmettez pas de valeur, rien n'est écrit à la base de données et que l'enfant reste vide (mais vous pouvez utiliser la Reference ailleurs).

Les clés uniques générées par push() sont commandées par l'heure actuelle, donc la liste des éléments résultante est triée chronologiquement. Les clés sont également conçues pour être inutile (elles contiennent 72 bits aléatoires d'entropie).

Voir Ajouter une liste de données . Voir les 2 ^ 120 façons d'assurer des identifiants uniques .

Signature:

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

Paramètres

Paramètre Taper Description
parent DatabaseReference L'emplacement parent.
valeur inconnu Valeur facultative à écrire à l'emplacement généré.

Retour:

Thereablereference

Promise et Reference combinées ; se résout lorsque l'écriture est terminée, mais peut être utilisée immédiatement comme Reference à l'emplacement de l'enfant.

fonction (chemin, ...)

OrderByChild (Path)

Crée une nouvelle QueryConstraint qui ordonne par la clé d'enfant spécifiée.

Les requêtes ne peuvent commander qu'une seule clé à la fois. Appeler orderByChild() plusieurs fois sur la même requête est une erreur.

Les requêtes Firebase vous permettent de commander vos données par n'importe quelle clé enfant à la volée. Cependant, si vous savez à l'avance quels seront vos index, vous pouvez les définir via la règle .Indexon dans vos règles de sécurité pour de meilleures performances. Voir le https://firebase.google.com/docs/database/security/indexing-data pour plus d'informations.

Vous pouvez en savoir plus sur orderByChild() dans les données de tri .

Signature:

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

Paramètres

Paramètre Taper Description
chemin chaîne Le chemin d'ordre par.

Retour:

Requête

fonction (requête, ...)

Get (requête)

Obtient le résultat le plus à jour pour cette requête.

Signature:

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

Paramètres

Paramètre Taper Description
requête Requête La requête à exécuter.

Retour:

Promesse < datasnapshot >

Une Promise qui se résout au DataSnapshot résultant si une valeur est disponible, ou rejette si le client n'est pas en mesure de renvoyer une valeur (par exemple, si le serveur est inaccessible et qu'il n'y a rien de cache).

OFF (Query, EventType, rappel)

Détache un rappel précédemment attaché avec le correspondant on*() ( onValue , onChildAdded ) Écouteur. Remarque: Ce n'est pas le moyen recommandé de supprimer un auditeur. Au lieu de cela, veuillez utiliser la fonction de rappel renvoyée à partir des rappels respectifs on* .

Détachez un rappel précédemment attaché avec on*() . L'appel off() sur un auditeur parent ne supprimera pas automatiquement les auditeurs enregistrés sur les nœuds enfants, off() doit également être appelé sur des auditeurs d'enfants à supprimer le rappel.

Si un rappel n'est pas spécifié, tous les rappels de l'EventType spécifié seront supprimés. De même, si aucune EventType n'est spécifiée, tous les rappels de la Reference seront supprimés.

Les auditeurs individuels peuvent également être supprimés en invoquant leurs rappels de désabonnement.

Signature:

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

Paramètres

Paramètre Taper Description
requête Requête La requête avec laquelle l'auditeur a été enregistrée.
type d'événement Type d'événement L'une des chaînes suivantes: "Valeur", "Child_Added", "Child_Changed", "Child_Removed" ou "Child_Moved". S'il est omis, tous les rappels de la Reference seront supprimés.
rappeler (Instantané: DataSnapshot , PrécéaireChildName ?: String | null) => inconnu La fonction de rappel qui a été transmise on() ou undefined pour supprimer tous les rappels.

Retour:

vide

OnchildAdded (requête, rappel, annulation)

Écoute les modifications de données à un emplacement particulier.

C'est le principal moyen de lire les données d'une base de données. Votre rappel sera déclenché pour les données initiales et à nouveau chaque fois que les données changent. Invoquez le rappel de désabonnement retourné pour cesser de recevoir des mises à jour. Voir Récupérer les données sur le Web pour plus de détails.

Un événement onChildAdded sera déclenché une fois pour chaque enfant initial à cet endroit, et il sera à nouveau déclenché chaque fois qu'un nouvel enfant est ajouté. Le DataSnapshot transmis dans le rappel reflétera les données de l'enfant concerné. À des fins de commande, il est passé un deuxième argument qui est une chaîne contenant la clé de l'enfant et sœur précédente par ordre de tri, ou null s'il s'agit du premier enfant.

Signature:

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

Paramètres

Paramètre Taper Description
requête Requête La requête à exécuter.
rappeler (Instantané: DataSnapshot , PrécéaireChildName ?: String | null) => inconnu Un rappel qui tire lorsque l'événement spécifié se produit. Le rappel passera un DataSnapshot et une chaîne contenant la clé de l'enfant précédent, par ordre de tri ou null s'il s'agit du premier enfant.
CancelCallback (erreur: erreur) => inconnu Un rappel facultatif qui sera informé si votre abonnement d'événement est jamais annulé parce que votre client n'a pas la permission de lire ces données (ou il a eu la permission mais l'a maintenant perdu). Ce rappel sera passé un objet Error indiquant pourquoi la défaillance s'est produite.

Retour:

Se désabonner

Une fonction qui peut être invoquée pour supprimer l'auditeur.

onchildadded (requête, rappel, options)

Écoute les modifications de données à un emplacement particulier.

C'est le principal moyen de lire les données d'une base de données. Votre rappel sera déclenché pour les données initiales et à nouveau chaque fois que les données changent. Invoquez le rappel de désabonnement retourné pour cesser de recevoir des mises à jour. Voir Récupérer les données sur le Web pour plus de détails.

Un événement onChildAdded sera déclenché une fois pour chaque enfant initial à cet endroit, et il sera à nouveau déclenché chaque fois qu'un nouvel enfant est ajouté. Le DataSnapshot transmis dans le rappel reflétera les données de l'enfant concerné. À des fins de commande, il est passé un deuxième argument qui est une chaîne contenant la clé de l'enfant et sœur précédente par ordre de tri, ou null s'il s'agit du premier enfant.

Signature:

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

Paramètres

Paramètre Taper Description
requête Requête La requête à exécuter.
rappeler (Instantané: DataSnapshot , PrécédentchildName: String | null) => inconnu Un rappel qui tire lorsque l'événement spécifié se produit. Le rappel passera un DataSnapshot et une chaîne contenant la clé de l'enfant précédent, par ordre de tri ou null s'il s'agit du premier enfant.
choix Écoute Un objet qui peut être utilisé pour configurer onlyOnce , qui supprime ensuite l'auditeur après sa première invocation.

Retour:

Se désabonner

Une fonction qui peut être invoquée pour supprimer l'auditeur.

OnchildAdded (requête, rappel, CancelCallback, Options)

Écoute les modifications de données à un emplacement particulier.

C'est le principal moyen de lire les données d'une base de données. Votre rappel sera déclenché pour les données initiales et à nouveau chaque fois que les données changent. Invoquez le rappel de désabonnement retourné pour cesser de recevoir des mises à jour. Voir Récupérer les données sur le Web pour plus de détails.

Un événement onChildAdded sera déclenché une fois pour chaque enfant initial à cet endroit, et il sera à nouveau déclenché chaque fois qu'un nouvel enfant est ajouté. Le DataSnapshot transmis dans le rappel reflétera les données de l'enfant concerné. À des fins de commande, il est passé un deuxième argument qui est une chaîne contenant la clé de l'enfant et sœur précédente par ordre de tri, ou null s'il s'agit du premier enfant.

Signature:

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

Paramètres

Paramètre Taper Description
requête Requête La requête à exécuter.
rappeler (Instantané: DataSnapshot , PrécédentchildName: String | null) => inconnu Un rappel qui tire lorsque l'événement spécifié se produit. Le rappel passera un DataSnapshot et une chaîne contenant la clé de l'enfant précédent, par ordre de tri ou null s'il s'agit du premier enfant.
CancelCallback (erreur: erreur) => inconnu Un rappel facultatif qui sera informé si votre abonnement d'événement est jamais annulé parce que votre client n'a pas la permission de lire ces données (ou il a eu la permission mais l'a maintenant perdu). Ce rappel sera passé un objet Error indiquant pourquoi la défaillance s'est produite.
choix Écoute Un objet qui peut être utilisé pour configurer onlyOnce , qui supprime ensuite l'auditeur après sa première invocation.

Retour:

Se désabonner

Une fonction qui peut être invoquée pour supprimer l'auditeur.

OnchildChanged (requête, rappel, annulation)

Écoute les modifications de données à un emplacement particulier.

C'est le principal moyen de lire les données d'une base de données. Votre rappel sera déclenché pour les données initiales et à nouveau chaque fois que les données changent. Invoquez le rappel de désabonnement retourné pour cesser de recevoir des mises à jour. Voir Récupérer les données sur le Web pour plus de détails.

Un événement onChildChanged sera déclenché lorsque les données stockées chez un enfant (ou l'un de ses descendants) changent. Notez qu'un seul événement child_changed peut représenter plusieurs modifications à l'enfant. Le DataSnapshot transmis au rappel contiendra le nouveau contenu de l'enfant. À des fins de commande, le rappel est également passé un deuxième argument qui est une chaîne contenant la clé de l'enfant de frère précédent par ordre de tri, ou null s'il s'agit du premier enfant.

Signature:

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

Paramètres

Paramètre Taper Description
requête Requête La requête à exécuter.
rappeler (Instantané: DataSnapshot , PrécédentchildName: String | null) => inconnu Un rappel qui tire lorsque l'événement spécifié se produit. Le rappel passera un DataSnapshot et une chaîne contenant la clé de l'enfant précédent, par ordre de tri ou null s'il s'agit du premier enfant.
CancelCallback (erreur: erreur) => inconnu Un rappel facultatif qui sera informé si votre abonnement d'événement est jamais annulé parce que votre client n'a pas la permission de lire ces données (ou il a eu la permission mais l'a maintenant perdu). Ce rappel sera passé un objet Error indiquant pourquoi la défaillance s'est produite.

Retour:

Se désabonner

Une fonction qui peut être invoquée pour supprimer l'auditeur.

onChildChanged (requête, rappel, options)

Écoute les modifications de données à un emplacement particulier.

C'est le principal moyen de lire les données d'une base de données. Votre rappel sera déclenché pour les données initiales et à nouveau chaque fois que les données changent. Invoquez le rappel de désabonnement retourné pour cesser de recevoir des mises à jour. Voir Récupérer les données sur le Web pour plus de détails.

Un événement onChildChanged sera déclenché lorsque les données stockées chez un enfant (ou l'un de ses descendants) changent. Notez qu'un seul événement child_changed peut représenter plusieurs modifications à l'enfant. Le DataSnapshot transmis au rappel contiendra le nouveau contenu de l'enfant. À des fins de commande, le rappel est également passé un deuxième argument qui est une chaîne contenant la clé de l'enfant de frère précédent par ordre de tri, ou null s'il s'agit du premier enfant.

Signature:

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

Paramètres

Paramètre Taper Description
requête Requête La requête à exécuter.
rappeler (Instantané: DataSnapshot , PrécédentchildName: String | null) => inconnu Un rappel qui tire lorsque l'événement spécifié se produit. Le rappel passera un DataSnapshot et une chaîne contenant la clé de l'enfant précédent, par ordre de tri ou null s'il s'agit du premier enfant.
choix Écoute Un objet qui peut être utilisé pour configurer onlyOnce , qui supprime ensuite l'auditeur après sa première invocation.

Retour:

Se désabonner

Une fonction qui peut être invoquée pour supprimer l'auditeur.

onchildChanged (requête, rappel, annulation, options)

Écoute les modifications de données à un emplacement particulier.

C'est le principal moyen de lire les données d'une base de données. Votre rappel sera déclenché pour les données initiales et à nouveau chaque fois que les données changent. Invoquez le rappel de désabonnement retourné pour cesser de recevoir des mises à jour. Voir Récupérer les données sur le Web pour plus de détails.

Un événement onChildChanged sera déclenché lorsque les données stockées chez un enfant (ou l'un de ses descendants) changent. Notez qu'un seul événement child_changed peut représenter plusieurs modifications à l'enfant. Le DataSnapshot transmis au rappel contiendra le nouveau contenu de l'enfant. À des fins de commande, le rappel est également passé un deuxième argument qui est une chaîne contenant la clé de l'enfant de frère précédent par ordre de tri, ou null s'il s'agit du premier enfant.

Signature:

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

Paramètres

Paramètre Taper Description
requête Requête La requête à exécuter.
rappeler (Instantané: DataSnapshot , PrécédentchildName: String | null) => inconnu Un rappel qui tire lorsque l'événement spécifié se produit. Le rappel passera un DataSnapshot et une chaîne contenant la clé de l'enfant précédent, par ordre de tri ou null s'il s'agit du premier enfant.
CancelCallback (erreur: erreur) => inconnu Un rappel facultatif qui sera informé si votre abonnement d'événement est jamais annulé parce que votre client n'a pas la permission de lire ces données (ou il a eu la permission mais l'a maintenant perdu). Ce rappel sera passé un objet Error indiquant pourquoi la défaillance s'est produite.
choix Écoute Un objet qui peut être utilisé pour configurer onlyOnce , qui supprime ensuite l'auditeur après sa première invocation.

Retour:

Se désabonner

Une fonction qui peut être invoquée pour supprimer l'auditeur.

OnChildMoved (Query, rappel, CancelCallback)

Écoute les modifications de données à un emplacement particulier.

C'est le principal moyen de lire les données d'une base de données. Votre rappel sera déclenché pour les données initiales et à nouveau chaque fois que les données changent. Invoquez le rappel de désabonnement retourné pour cesser de recevoir des mises à jour. Voir Récupérer les données sur le Web pour plus de détails.

Un événement onChildMoved sera déclenché lorsque l'ordre de tri d'un enfant change de telle sorte que sa position par rapport à ses frères et sœurs change. Le DataSnapshot transmis au rappel sera pour les données de l'enfant qui a déménagé. Il est également passé un deuxième argument qui est une chaîne contenant la clé de l'enfant frères précédent par ordre de tri, ou null s'il s'agit du premier enfant.

Signature:

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

Paramètres

Paramètre Taper Description
requête Requête La requête à exécuter.
rappeler (Instantané: DataSnapshot , PrécédentchildName: String | null) => inconnu Un rappel qui tire lorsque l'événement spécifié se produit. Le rappel passera un DataSnapshot et une chaîne contenant la clé de l'enfant précédent, par ordre de tri ou null s'il s'agit du premier enfant.
CancelCallback (erreur: erreur) => inconnu Un rappel facultatif qui sera informé si votre abonnement d'événement est jamais annulé parce que votre client n'a pas la permission de lire ces données (ou il a eu la permission mais l'a maintenant perdu). Ce rappel sera passé un objet Error indiquant pourquoi la défaillance s'est produite.

Retour:

Se désabonner

Une fonction qui peut être invoquée pour supprimer l'auditeur.

OnChildMoved (requête, rappel, options)

Écoute les modifications de données à un emplacement particulier.

C'est le principal moyen de lire les données d'une base de données. Votre rappel sera déclenché pour les données initiales et à nouveau chaque fois que les données changent. Invoquez le rappel de désabonnement retourné pour cesser de recevoir des mises à jour. Voir Récupérer les données sur le Web pour plus de détails.

Un événement onChildMoved sera déclenché lorsque l'ordre de tri d'un enfant change de telle sorte que sa position par rapport à ses frères et sœurs change. Le DataSnapshot transmis au rappel sera pour les données de l'enfant qui a déménagé. Il est également passé un deuxième argument qui est une chaîne contenant la clé de l'enfant frères précédent par ordre de tri, ou null s'il s'agit du premier enfant.

Signature:

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

Paramètres

Paramètre Taper Description
requête Requête La requête à exécuter.
rappeler (Instantané: DataSnapshot , PrécédentchildName: String | null) => inconnu Un rappel qui tire lorsque l'événement spécifié se produit. Le rappel passera un DataSnapshot et une chaîne contenant la clé de l'enfant précédent, par ordre de tri ou null s'il s'agit du premier enfant.
choix Écoute Un objet qui peut être utilisé pour configurer onlyOnce , qui supprime ensuite l'auditeur après sa première invocation.

Retour:

Se désabonner

Une fonction qui peut être invoquée pour supprimer l'auditeur.

OnChildMoved (requête, rappel, CancelCallback, Options)

Écoute les modifications de données à un emplacement particulier.

C'est le principal moyen de lire les données d'une base de données. Votre rappel sera déclenché pour les données initiales et à nouveau chaque fois que les données changent. Invoquez le rappel de désabonnement retourné pour cesser de recevoir des mises à jour. Voir Récupérer les données sur le Web pour plus de détails.

Un événement onChildMoved sera déclenché lorsque l'ordre de tri d'un enfant change de telle sorte que sa position par rapport à ses frères et sœurs change. Le DataSnapshot transmis au rappel sera pour les données de l'enfant qui a déménagé. Il est également passé un deuxième argument qui est une chaîne contenant la clé de l'enfant frères précédent par ordre de tri, ou null s'il s'agit du premier enfant.

Signature:

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

Paramètres

Paramètre Taper Description
requête Requête La requête à exécuter.
rappeler (Instantané: DataSnapshot , PrécédentchildName: String | null) => inconnu Un rappel qui tire lorsque l'événement spécifié se produit. Le rappel passera un DataSnapshot et une chaîne contenant la clé de l'enfant précédent, par ordre de tri ou null s'il s'agit du premier enfant.
CancelCallback (erreur: erreur) => inconnu Un rappel facultatif qui sera informé si votre abonnement d'événement est jamais annulé parce que votre client n'a pas la permission de lire ces données (ou il a eu la permission mais l'a maintenant perdu). Ce rappel sera passé un objet Error indiquant pourquoi la défaillance s'est produite.
choix Écoute Un objet qui peut être utilisé pour configurer onlyOnce , qui supprime ensuite l'auditeur après sa première invocation.

Retour:

Se désabonner

Une fonction qui peut être invoquée pour supprimer l'auditeur.

onChildRemoved (requête, rappel, CancelCallback)

Écoute les modifications de données à un emplacement particulier.

C'est le principal moyen de lire les données d'une base de données. Votre rappel sera déclenché pour les données initiales et à nouveau chaque fois que les données changent. Invoquez le rappel de désabonnement retourné pour cesser de recevoir des mises à jour. Voir Récupérer les données sur le Web pour plus de détails.

Un événement onChildRemoved sera déclenché une fois à chaque fois qu'un enfant est retiré. Le DataSnapshot transmis dans le rappel sera les anciennes données de l'enfant qui a été supprimée. Un enfant sera supprimé lorsque soit:

  • Un client appelle explicitement remove() sur cet enfant ou l'un de ses ancêtres - un set(null) sur cet enfant ou l'un de ses ancêtres - cet enfant a tous ses enfants supprimés - il y a une requête en vigueur qui filtre maintenant maintenant L'enfant (parce que l'ordre de tri a changé ou que la limite maximale a été frappée)

Signature:

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

Paramètres

Paramètre Taper Description
requête Requête La requête à exécuter.
rappeler (Instantané: DataSnapshot ) => inconnu Un rappel qui tire lorsque l'événement spécifié se produit. Le rappel passera un DataSnapshot et une chaîne contenant la clé de l'enfant précédent, par ordre de tri ou null s'il s'agit du premier enfant.
CancelCallback (erreur: erreur) => inconnu Un rappel facultatif qui sera informé si votre abonnement d'événement est jamais annulé parce que votre client n'a pas la permission de lire ces données (ou il a eu la permission mais l'a maintenant perdu). Ce rappel sera passé un objet Error indiquant pourquoi la défaillance s'est produite.

Retour:

Se désabonner

Une fonction qui peut être invoquée pour supprimer l'auditeur.

onchildremoved (requête, rappel, options)

Écoute les modifications de données à un emplacement particulier.

C'est le principal moyen de lire les données d'une base de données. Votre rappel sera déclenché pour les données initiales et à nouveau chaque fois que les données changent. Invoquez le rappel de désabonnement retourné pour cesser de recevoir des mises à jour. Voir Récupérer les données sur le Web pour plus de détails.

Un événement onChildRemoved sera déclenché une fois à chaque fois qu'un enfant est retiré. Le DataSnapshot transmis dans le rappel sera les anciennes données de l'enfant qui a été supprimée. Un enfant sera supprimé lorsque soit:

  • Un client appelle explicitement remove() sur cet enfant ou l'un de ses ancêtres - un set(null) sur cet enfant ou l'un de ses ancêtres - cet enfant a tous ses enfants supprimés - il y a une requête en vigueur qui filtre maintenant maintenant L'enfant (parce que l'ordre de tri a changé ou que la limite maximale a été frappée)

Signature:

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

Paramètres

Paramètre Taper Description
requête Requête La requête à exécuter.
rappeler (Instantané: DataSnapshot ) => inconnu Un rappel qui tire lorsque l'événement spécifié se produit. Le rappel passera un DataSnapshot et une chaîne contenant la clé de l'enfant précédent, par ordre de tri ou null s'il s'agit du premier enfant.
choix Écoute Un objet qui peut être utilisé pour configurer onlyOnce , qui supprime ensuite l'auditeur après sa première invocation.

Retour:

Se désabonner

Une fonction qui peut être invoquée pour supprimer l'auditeur.

OnChilDReMoved (requête, rappel, CancelCallback, Options)

Écoute les modifications de données à un emplacement particulier.

C'est le principal moyen de lire les données d'une base de données. Votre rappel sera déclenché pour les données initiales et à nouveau chaque fois que les données changent. Invoquez le rappel de désabonnement retourné pour cesser de recevoir des mises à jour. Voir Récupérer les données sur le Web pour plus de détails.

Un événement onChildRemoved sera déclenché une fois à chaque fois qu'un enfant est retiré. Le DataSnapshot transmis dans le rappel sera les anciennes données de l'enfant qui a été supprimée. Un enfant sera supprimé lorsque soit:

  • Un client appelle explicitement remove() sur cet enfant ou l'un de ses ancêtres - un set(null) sur cet enfant ou l'un de ses ancêtres - cet enfant a tous ses enfants supprimés - il y a une requête en vigueur qui filtre maintenant maintenant L'enfant (parce que l'ordre de tri a changé ou que la limite maximale a été frappée)

Signature:

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

Paramètres

Paramètre Taper Description
requête Requête La requête à exécuter.
rappeler (Instantané: DataSnapshot ) => inconnu Un rappel qui tire lorsque l'événement spécifié se produit. Le rappel passera un DataSnapshot et une chaîne contenant la clé de l'enfant précédent, par ordre de tri ou null s'il s'agit du premier enfant.
CancelCallback (erreur: erreur) => inconnu Un rappel facultatif qui sera informé si votre abonnement d'événement est jamais annulé parce que votre client n'a pas la permission de lire ces données (ou il a eu la permission mais l'a maintenant perdu). Ce rappel sera passé un objet Error indiquant pourquoi la défaillance s'est produite.
choix Écoute Un objet qui peut être utilisé pour configurer onlyOnce , qui supprime ensuite l'auditeur après sa première invocation.

Retour:

Se désabonner

Une fonction qui peut être invoquée pour supprimer l'auditeur.

OnValue (Query, Rallback, CancelCallback)

Écoute les modifications de données à un emplacement particulier.

C'est le principal moyen de lire les données d'une base de données. Votre rappel sera déclenché pour les données initiales et à nouveau chaque fois que les données changent. Invoquez le rappel de désabonnement retourné pour cesser de recevoir des mises à jour. Voir Récupérer les données sur le Web pour plus de détails.

Un événement onValue déclenchera une fois avec les données initiales stockées à cet emplacement, puis déclenchera à nouveau chaque fois que les données changent. Le DataSnapshot transmis au rappel sera pour l'emplacement où on() a été appelé. Il ne se déclenchera pas tant que l'ensemble du contenu n'a pas été synchronisé. Si l'emplacement n'a pas de données, elle sera déclenchée avec un DataSnapshot vide ( val() renverra null ).

Signature:

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

Paramètres

Paramètre Taper Description
requête Requête La requête à exécuter.
rappeler (Instantané: DataSnapshot ) => inconnu Un rappel qui tire lorsque l'événement spécifié se produit. Le rappel passera un DataSnapshot.
CancelCallback (erreur: erreur) => inconnu Un rappel facultatif qui sera informé si votre abonnement d'événement est jamais annulé parce que votre client n'a pas la permission de lire ces données (ou il a eu la permission mais l'a maintenant perdu). Ce rappel sera passé un objet Error indiquant pourquoi la défaillance s'est produite.

Retour:

Se désabonner

Une fonction qui peut être invoquée pour supprimer l'auditeur.

OnValue (requête, rappel, options)

Écoute les modifications de données à un emplacement particulier.

C'est le principal moyen de lire les données d'une base de données. Votre rappel sera déclenché pour les données initiales et à nouveau chaque fois que les données changent. Invoquez le rappel de désabonnement retourné pour cesser de recevoir des mises à jour. Voir Récupérer les données sur le Web pour plus de détails.

Un événement onValue déclenchera une fois avec les données initiales stockées à cet emplacement, puis déclenchera à nouveau chaque fois que les données changent. Le DataSnapshot transmis au rappel sera pour l'emplacement où on() a été appelé. Il ne se déclenchera pas tant que l'ensemble du contenu n'a pas été synchronisé. Si l'emplacement n'a pas de données, elle sera déclenchée avec un DataSnapshot vide ( val() renverra null ).

Signature:

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

Paramètres

Paramètre Taper Description
requête Requête La requête à exécuter.
rappeler (Instantané: DataSnapshot ) => inconnu Un rappel qui tire lorsque l'événement spécifié se produit. Le rappel passera un DataSnapshot.
choix Écoute Un objet qui peut être utilisé pour configurer onlyOnce , qui supprime ensuite l'auditeur après sa première invocation.

Retour:

Se désabonner

Une fonction qui peut être invoquée pour supprimer l'auditeur.

OnValue (requête, rappel, CancelCallback, Options)

Écoute les modifications de données à un emplacement particulier.

C'est le principal moyen de lire les données d'une base de données. Votre rappel sera déclenché pour les données initiales et à nouveau chaque fois que les données changent. Invoquez le rappel de désabonnement retourné pour cesser de recevoir des mises à jour. Voir Récupérer les données sur le Web pour plus de détails.

Un événement onValue déclenchera une fois avec les données initiales stockées à cet emplacement, puis déclenchera à nouveau chaque fois que les données changent. Le DataSnapshot transmis au rappel sera pour l'emplacement où on() a été appelé. Il ne se déclenchera pas tant que l'ensemble du contenu n'a pas été synchronisé. Si l'emplacement n'a pas de données, elle sera déclenchée avec un DataSnapshot vide ( val() renverra null ).

Signature:

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

Paramètres

Paramètre Taper Description
requête Requête La requête à exécuter.
rappeler (Instantané: DataSnapshot ) => inconnu Un rappel qui tire lorsque l'événement spécifié se produit. Le rappel passera un DataSnapshot.
CancelCallback (erreur: erreur) => inconnu Un rappel facultatif qui sera informé si votre abonnement d'événement est jamais annulé parce que votre client n'a pas la permission de lire ces données (ou il a eu la permission mais l'a maintenant perdu). Ce rappel sera passé un objet Error indiquant pourquoi la défaillance s'est produite.
choix Écoute Un objet qui peut être utilisé pour configurer onlyOnce , qui supprime ensuite l'auditeur après sa première invocation.

Retour:

Se désabonner

Une fonction qui peut être invoquée pour supprimer l'auditeur.

requête (requête, requêtes)

Crée une nouvelle instance immuable de Query qui est étendue pour inclure également des contraintes de requête supplémentaires.

Signature:

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

Paramètres

Paramètre Taper Description
requête Requête L'instance de requête à utiliser comme base pour les nouvelles contraintes.
requêtes Requête [] La liste des QueryConstraint à appliquer.

Retour:

Requête

Des exceptions

Si l'une des contraintes de requête fournies ne peut être combinée avec les contraintes existantes ou nouvelles.

fonction (réf, ...)

onDisconnect (réf)

Renvoie un objet OnDisconnect - voir Activation des capacités hors ligne en JavaScript pour plus d'informations sur la façon de les utiliser.

Signature:

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

Paramètres

Paramètre Taper Description
réf DatabaseReference La référence pour ajouter onDisconnect déclenche.

Retour:

Ondisconnect

supprimer (réf)

Supprime les données à cet emplacement de base de données.

Toutes les données chez les enfants seront également supprimées.

L'effet de la suppression sera immédiatement visible et la «valeur» de l'événement correspondant sera déclenchée. La synchronisation de la suppression des serveurs de base de feu sera également démarrée, et la promesse retournée se résoudra une fois terminé. S'il est fourni, le rappel OnComplete sera appelé de manière asynchrone une fois la synchronisation terminée.

Signature:

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

Paramètres

Paramètre Taper Description
réf DatabaseReference The location to remove.

Retour:

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.

Signature:

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

Paramètres

Paramètre Taper Description
réf DatabaseReference The location to atomically modify.
transactionUpdate (currentData: any) => unknown A developer-supplied function which will be passed the current data stored at this location (as a JavaScript object). The function should return the new value it would like written (as a JavaScript object). If undefined is returned (ie you return with no arguments) the transaction will be aborted and the data at this location will not be modified.
choix TransactionOptions An options object to configure transactions.

Retour:

Promise< TransactionResult >

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

set(réf, valeur)

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.

Signature:

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

Paramètres

Paramètre Taper Description
réf DatabaseReference The location to write to.
valeur inconnu The value to be written (string, number, boolean, object, array, or null).

Retour:

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 ).

Signature:

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

Paramètres

Paramètre Taper Description
réf DatabaseReference The location to write to.
priorité string | numéro | nul The priority to be written (string, number, or null).

Retour:

Promise<void>

Resolves when write to server is complete.

setWithPriority(réf, valeur, priorité)

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 ).

Signature:

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

Paramètres

Paramètre Taper Description
réf DatabaseReference The location to write to.
valeur inconnu The value to be written (string, number, boolean, object, array, or null).
priorité string | numéro | nul The priority to be written (string, number, or null).

Retour:

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 .

Signature:

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

Paramètres

Paramètre Taper Description
réf DatabaseReference The location to write to.
valeurs objet Object containing multiple values.

Retour:

Promise<void>

Resolves when update on server is complete.

fonction(valeur, ...)

endAt (valeur, clé)

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 .

Signature:

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

Paramètres

Paramètre Taper Description
valeur numéro | string | boolean | nul The value to end at. The argument type depends on which orderBy () function was used in this query. Specify a value that matches the orderBy () type. When used in combination with orderByKey() , the value must be a string.
clé chaîne The child key to end at, among the children with the previously specified priority. This argument is only allowed if ordering by child, value, or priority.

Retour:

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.

Signature:

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

Paramètres

Paramètre Taper Description
valeur numéro | string | boolean | nul The value to end before. The argument type depends on which orderBy () function was used in this query. Specify a value that matches the orderBy () type. When used in combination with orderByKey() , the value must be a string.
clé chaîne The child key to end before, among the children with the previously specified priority. This argument is only allowed if ordering by child, value, or priority.

Retour:

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 .

Signature:

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

Paramètres

Paramètre Taper Description
valeur numéro | string | boolean | nul The value to match for. The argument type depends on which orderBy () function was used in this query. Specify a value that matches the orderBy () type. When used in combination with orderByKey() , the value must be a string.
clé chaîne The child key to start at, among the children with the previously specified priority. This argument is only allowed if ordering by child, value, or priority.

Retour:

QueryConstraint

startAfter (valeur, clé)

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.

Signature:

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

Paramètres

Paramètre Taper Description
valeur numéro | string | boolean | nul The value to start after. The argument type depends on which orderBy () function was used in this query. Specify a value that matches the orderBy () type. When used in combination with orderByKey() , the value must be a string.
clé chaîne The child key to start after. This argument is only allowed if ordering by child, value, or priority.

Retour:

QueryConstraint

startAt (valeur, clé)

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 .

Signature:

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

Paramètres

Paramètre Taper Description
valeur numéro | string | boolean | nul The value to start at. The argument type depends on which orderBy () function was used in this query. Specify a value that matches the orderBy () type. When used in combination with orderByKey() , the value must be a string.
clé chaîne The child key to start at. This argument is only allowed if ordering by child, value, or priority.

Retour:

QueryConstraint

Type d'événement

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

Signature:

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

QueryConstraintType

Describes the different query constraints available in this SDK.

Signature:

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

Se désabonner

A callback that can invoked to remove a listener.

Signature:

export declare type Unsubscribe = () => void;