DocumentReference class

Restez organisé à l'aide des collections Enregistrez et classez les contenus selon vos préférences.

Un DocumentReference fait référence à un emplacement de document dans une base de données Firestore et peut être utilisé pour écrire, lire ou écouter l'emplacement. Le document à l’emplacement référencé peut exister ou non.

Signature:

export declare class DocumentReference 

Propriétés

Méthodes

DocumentReference.converter

S'il est fourni, le FirestoreDataConverter associé à cette instance.

Signature:

readonly converter: FirestoreDataConverter | null;

DocumentReference.firestore

L'instance Firestore dans laquelle se trouve le document. Ceci est utile pour effectuer des transactions, par exemple.

Signature:

readonly firestore: Firestore;

DocumentReference.id

L'identifiant du document au sein de sa collection.

Signature:

get id(): string;

DocumentReference.parent

Collection à laquelle appartient ce DocumentReference .

Signature:

get parent(): CollectionReference;

DocumentReference.path

Une chaîne représentant le chemin du document référencé (par rapport à la racine de la base de données).

Signature:

get path(): string;

DocumentReference.type

Le type de cette référence Firestore.

Signature:

readonly type = "document";

DocumentReference.withConverter()

Applique un convertisseur de données personnalisé à ce DocumentReference , vous permettant d'utiliser vos propres objets de modèle personnalisés avec Firestore. Lorsque vous appelez setDoc() , getDoc() , etc. avec l'instance DocumentReference renvoyée, le convertisseur fourni convertira entre les données Firestore de type NewDbModelType et votre type personnalisé NewAppModelType .

Signature:

withConverter(converter: FirestoreDataConverter): DocumentReference;

Paramètres

Retour:

Référence de document

DocumentReference qui utilise le convertisseur fourni.

DocumentReference.withConverter()

Supprime le convertisseur actuel.

Signature:

withConverter(converter: null): DocumentReference;

Paramètres

Retour:

Référence de document < DocumentDonnées , DocumentData >

DocumentReference qui n'utilise pas de convertisseur.