Un DocumentSnapshot contient des données lues à partir d'un document dans votre base de données Firestore. Les données peuvent être extraites avec .data() ou .get(<field>) pour obtenir un champ spécifique.
Pour un DocumentSnapshot qui pointe vers un document inexistant, tout accès aux données renverra « non défini ». Vous pouvez utiliser la méthode exists() pour vérifier explicitement l'existence d'un document.
Signature:
export declare class DocumentSnapshot<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData>
Constructeurs
| Constructeur | Modificateurs | Description |
|---|---|---|
| (constructeur)() | Construit une nouvelle instance de la classe DocumentSnapshot |
Propriétés
| Propriété | Modificateurs | Taper | Description |
|---|---|---|---|
| identifiant | chaîne | Propriété du DocumentSnapshot qui fournit l'ID du document. | |
| métadonnées | Métadonnées d'instantané | Métadonnées sur le DocumentSnapshot , y compris des informations sur sa source et ses modifications locales. | |
| réf | Référence de document <AppModelType, DbModelType> | DocumentReference pour le document inclus dans DocumentSnapshot . |
Méthodes
| Méthode | Modificateurs | Description |
|---|---|---|
| données (options) | Récupère tous les champs du document en tant Object . Renvoie undefined si le document n'existe pas. 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. | |
| existe() | Renvoie si les données existent ou non. Vrai si le document existe. | |
| obtenir (chemin de champ, options) | Récupère le champ spécifié par fieldPath . Renvoie undefined si le document ou le champ n'existe pas. Par défaut, un serverTimestamp() qui n'a pas encore été défini sur sa valeur finale sera renvoyé sous la forme null . Vous pouvez remplacer cela en passant un objet options. |
DocumentSnapshot. (constructeur)
Construit une nouvelle instance de la classe DocumentSnapshot
Signature:
protected constructor();
DocumentSnapshot.id
Propriété du DocumentSnapshot qui fournit l'ID du document.
Signature:
get id(): string;
DocumentSnapshot.metadonnées
Métadonnées sur le DocumentSnapshot , y compris des informations sur sa source et ses modifications locales.
Signature:
readonly metadata: SnapshotMetadata;
DocumentSnapshot.ref
DocumentReference pour le document inclus dans DocumentSnapshot .
Signature:
get ref(): DocumentReference<AppModelType, DbModelType>;
DocumentSnapshot.data()
Récupère tous les champs du document en tant Object . Renvoie undefined si le document n'existe pas.
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:
data(options?: SnapshotOptions): AppModelType | undefined;
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 | indéfini
Un Object contenant tous les champs du document ou undefined si le document n'existe pas.
DocumentSnapshot.exists()
Renvoie si les données existent ou non. Vrai si le document existe.
Signature:
exists(): this is QueryDocumentSnapshot<AppModelType, DbModelType>;
Retour:
c'est QueryDocumentSnapshot <AppModelType, DbModelType>
DocumentSnapshot.get()
Récupère le champ spécifié par fieldPath . Renvoie undefined si le document ou le champ n'existe pas.
Par défaut, un serverTimestamp() qui n'a pas encore été défini sur sa valeur finale sera renvoyé comme null . Vous pouvez remplacer cela en passant un objet options.
Signature:
get(fieldPath: string | FieldPath, options?: SnapshotOptions): any;
Paramètres
| Paramètre | Taper | Description |
|---|---|---|
| champChemin | chaîne | Chemin de champ | Le chemin (par exemple « foo » ou « foo.bar ») vers un champ spécifique. |
| choix | Options d'instantané | Un objet d'options pour configurer la manière dont le champ est récupéré à 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:
n'importe lequel
Les données à l'emplacement du champ spécifié ou non définies si aucun champ de ce type n'existe dans le document.