QueryDocumentSnapshot class

Un QueryDocumentSnapshot contient des données lues à partir d'un document de votre base de données Firestore dans le cadre d'une requête. L'existence du document est garantie et ses données peuvent être extraites avec .data() ou .get(<field>) pour obtenir un champ spécifique.

Un QueryDocumentSnapshot offre la même surface API qu'un DocumentSnapshot . Étant donné que les résultats de la requête ne contiennent que des documents existants, la propriété exists sera toujours vraie et data() ne renverra jamais « undéfini ».

Signature:

export declare class QueryDocumentSnapshot<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData> extends DocumentSnapshot<AppModelType, DbModelType> 

Extension : DocumentSnapshot <AppModelType, DbModelType>

Méthodes

Méthode Modificateurs Description
données (options) Récupère tous les champs du document en tant Object . Par défaut, les valeurs serverTimestamp() qui n'ont pas encore été définies sur leur valeur finale seront renvoyées sous la forme null . Vous pouvez remplacer cela en passant un objet options.

QueryDocumentSnapshot.data()

Récupère tous les champs du document en tant Object .

Par défaut, les valeurs serverTimestamp() qui n'ont pas encore été définies sur leur valeur finale seront renvoyées comme null . Vous pouvez remplacer cela en passant un objet options.

Signature:

/** @override */
data(options?: SnapshotOptions): AppModelType;

Paramètres

Paramètre Taper Description
choix Options d'instantané Un objet d'options pour configurer la manière dont les données sont récupérées à partir de l'instantané (par exemple le comportement souhaité pour les horodatages du serveur qui n'ont pas encore été définis sur leur valeur finale).

Retour:

Type de modèle d'application

Un Object contenant tous les champs du document.