database.DataSnapshot class

Interface représentant un instantané des données d'une base de données Firebase Realtime.

Signature:

export declare class DataSnapshot implements database.DataSnapshot

Implémente : base de données.DataSnapshot

Constructeurs

Constructeur Modificateurs Description
(constructeur)(données, chemin, application, instance) Construit une nouvelle instance de la classe DataSnapshot

Propriétés

Propriété Modificateurs Taper Description
exemple chaîne
clé chaîne | nul La clé (dernière partie du chemin) de l'emplacement de ce DataSnapshot . Le dernier jeton d'un emplacement de base de données est considéré comme sa clé. Par exemple, « ada » est la clé du nœud /users/ada/ . L'accès à la clé sur n'importe quel DataSnapshot renvoie la clé de l'emplacement qui l'a généré. Cependant, l'accès à la clé sur l'URL racine d'une base de données renvoie null .
réf base de données.Référence Renvoie une [ Reference ](/docs/reference/admin/node/admin.database.Reference) à l'emplacement de la base de données où l'écriture déclenchante s'est produite. Dispose d'un accès complet en lecture et en écriture.

Méthodes

Méthode Modificateurs Description
enfant (chemin enfant) Obtient un DataSnapshot 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 »).
existe() Renvoie true si ce DataSnapshot contient des données. C'est légèrement plus efficace que d'utiliser snapshot.val() !== null . true si ce DataSnapshot contient des données ; sinon, false .
exportVal() Exporte l'intégralité du contenu du DataSnapshot en tant qu'objet JavaScript. Le contenu du DataSnapshot sous forme de valeur JavaScript (Object, Array, string, number, boolean ou null ).
pourChaque(action) Énumère les DataSnapshot des éléments enfants. En raison du fonctionnement des objets JavaScript, il n'est pas garanti que l'ordre des données dans l'objet JavaScript renvoyé par val() corresponde à l'ordre sur le serveur ni à l'ordre des événements child_added . C'est là que forEach() s'avère utile. Il garantit que les enfants d'un DataSnapshot peuvent être itérés dans leur ordre de requête. Si aucune méthode explicite orderBy*() n'est utilisée, les résultats sont renvoyés classés par clé (sauf si des priorités sont utilisées, auquel cas, les résultats sont renvoyés par priorité).
obtenirPriorité() Obtient la valeur de priorité des données dans ce DataSnapshot . Au lieu d'utiliser la priorité, les applications peuvent trier les collections par propriétés ordinaires. Voir [Tri et filtrage des données](/docs/database/web/lists-of-data#sorting_and_filtering_data). La valeur prioritaire des données.
hasChild (chemin enfant) Renvoie true si le chemin enfant spécifié contient des données (non null ).
a des enfants() Indique si le DataSnapshot possède ou non des propriétés enfants non null . Vous pouvez utiliser hasChildren() pour déterminer si un DataSnapshot a des enfants. Si c'est le cas, vous pouvez les énumérer en utilisant forEach() . Si ce n'est pas le cas, alors soit cet instantané contient une valeur primitive (qui peut être récupérée avec val() ), soit il est vide (auquel cas, val() renvoie null ). true si cet instantané a des enfants ; sinon false .
numEnfants() Renvoie le nombre de propriétés enfants de ce DataSnapshot . Nombre de propriétés enfants de ce DataSnapshot .
versJSON() Renvoie une représentation sérialisable JSON de cet objet. Une représentation sérialisable JSON de cet objet.
val() Extrait une valeur JavaScript d'un DataSnapshot . En fonction des données contenues dans un DataSnapshot , la méthode val() peut renvoyer un type scalaire (chaîne, nombre ou booléen), un tableau ou un objet. Il peut également renvoyer null , indiquant que le DataSnapshot est vide (ne contient aucune donnée). Le contenu de l'instantané sous forme de valeur JavaScript (Object, Array, string, number, boolean ou null ).

base de données.DataSnapshot.(constructeur)

Construit une nouvelle instance de la classe DataSnapshot

Signature:

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

Paramètres

Paramètre Taper Description
données n'importe lequel
chemin chaîne
application Application
exemple chaîne

base de données.DataSnapshot.instance

Signature:

instance: string;

base de données.DataSnapshot.key

La clé (dernière partie du chemin) de l'emplacement de ce DataSnapshot .

Le dernier jeton d'un emplacement de base de données est considéré comme sa clé. Par exemple, « ada » est la clé du nœud /users/ada/ . L'accès à la clé sur n'importe quel DataSnapshot renvoie la clé de l'emplacement qui l'a généré. Cependant, accéder à la clé sur l'URL racine d'une base de données renvoie null .

Signature:

get key(): string | null;

base de données.DataSnapshot.ref

Renvoie une [ Reference ](/docs/reference/admin/node/admin.database.Reference) à l'emplacement de la base de données où l'écriture déclenchante s'est produite. Dispose d'un accès complet en lecture et en écriture.

Signature:

get ref(): database.Reference;

base de données.DataSnapshot.child()

Obtient un DataSnapshot 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 »).

Signature:

child(childPath: string): DataSnapshot;

Paramètres

Paramètre Taper Description
CheminEnfant chaîne

Retour:

Aperçu des données

base de données.DataSnapshot.exists()

Renvoie true si ce DataSnapshot contient des données. C'est légèrement plus efficace que d'utiliser snapshot.val() !== null .

true si ce DataSnapshot contient des données ; sinon, false .

Signature:

exists(): boolean;

Retour:

booléen

base de données.DataSnapshot.exportVal()

Exporte l'intégralité du contenu du DataSnapshot en tant qu'objet JavaScript.

Le contenu du DataSnapshot sous forme de valeur JavaScript (objet, tableau, chaîne, nombre, booléen ou null ).

Signature:

exportVal(): any;

Retour:

n'importe lequel

base de données.DataSnapshot.forEach()

Énumère le DataSnapshot s des articles pour enfants.

En raison du fonctionnement des objets JavaScript, il n'est pas garanti que l'ordre des données dans l'objet JavaScript renvoyé par val() corresponde à l'ordre sur le serveur ni à l'ordre des événements child_added . C'est là que forEach() s'avère utile. Il garantit que les enfants d'un DataSnapshot peuvent être itérés dans leur ordre de requête.

Si aucune méthode explicite orderBy*() n'est utilisée, les résultats sont renvoyés classés par clé (sauf si des priorités sont utilisées, auquel cas, les résultats sont renvoyés par priorité).

Signature:

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

Paramètres

Paramètre Taper Description
action (a : IteratedDataSnapshot) => booléen | vide Une fonction appelée pour chaque enfant DataSnapshot . Le rappel peut renvoyer true pour annuler une énumération ultérieure. true si l'énumération a été annulée en raison du retour de votre rappel true .

Retour:

booléen

base de données.DataSnapshot.getPriority()

Obtient la valeur prioritaire des données dans ce DataSnapshot .

Au lieu d'utiliser la priorité, les applications peuvent trier les collections par propriétés ordinaires. Voir [Tri et filtrage des données](/docs/database/web/lists-of-data#sorting_and_filtering_data).

La valeur prioritaire des données.

Signature:

getPriority(): string | number | null;

Retour:

chaîne | numéro | nul

base de données.DataSnapshot.hasChild()

Renvoie true si le chemin enfant spécifié a (non null ) données.

Signature:

hasChild(childPath: string): boolean;

Paramètres

Paramètre Taper Description
CheminEnfant chaîne

Retour:

booléen

base de données.DataSnapshot.hasChildren()

Indique si le DataSnapshot possède ou non des propriétés enfants non null .

Vous pouvez utiliser hasChildren() pour déterminer si un DataSnapshot a des enfants. Si c'est le cas, vous pouvez les énumérer en utilisant forEach() . Si ce n'est pas le cas, alors soit cet instantané contient une valeur primitive (qui peut être récupérée avec val() ) ou il est vide (auquel cas, val() renvoie null ).

true si cet instantané a des enfants ; sinon false .

Signature:

hasChildren(): boolean;

Retour:

booléen

base de données.DataSnapshot.numChildren()

Renvoie le nombre de propriétés enfants de ce DataSnapshot .

Nombre de propriétés enfants de ce DataSnapshot .

Signature:

numChildren(): number;

Retour:

nombre

base de données.DataSnapshot.toJSON()

Renvoie une représentation sérialisable JSON de cet objet.

Une représentation sérialisable JSON de cet objet.

Signature:

toJSON(): Record<string, unknown>;

Retour:

Enregistrer<string, inconnu>

base de données.DataSnapshot.val()

Extrait une valeur JavaScript d'un DataSnapshot .

En fonction des données d'un DataSnapshot , la méthode val() peut renvoyer un type scalaire (chaîne, nombre ou booléen), un tableau ou un objet. Il peut également renvoyer null , indiquant que le DataSnapshot est vide (ne contient aucune donnée).

Le contenu de l'instantané sous forme de valeur JavaScript (objet, tableau, chaîne, nombre, booléen ou null ).

Signature:

val(): any;

Retour:

n'importe lequel