database package

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:

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:

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:

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:

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:

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:

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.

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:

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.

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:

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.

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:

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.

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:

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.

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:

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

OnChildMoved (Query, rappel, CancelCallback)

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

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:

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.

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:

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.

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:

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.

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:

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.

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:

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.

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:

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

OnValue (Query, Rallback, CancelCallback)

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

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:

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.

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:

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.

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:

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:

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:

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:

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:

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:

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: