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<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData>
Propriétés
| Propriété | Modificateurs | Taper | Description |
|---|---|---|---|
| convertisseur | Convertisseur de données Firestore <AppModelType, DbModelType> | nul | S'il est fourni, le FirestoreDataConverter associé à cette instance. | |
| magasin de feu | Firestore | L'instance Firestore dans laquelle se trouve le document. Ceci est utile pour effectuer des transactions, par exemple. | |
| identifiant | chaîne | L'identifiant du document au sein de sa collection. | |
| parent | CollectionRéférence <AppModelType, DbModelType> | Collection à laquelle appartient ce DocumentReference . | |
| chemin | chaîne | Une chaîne représentant le chemin du document référencé (par rapport à la racine de la base de données). | |
| taper | (non déclaré) | Le type de cette référence Firestore. |
Méthodes
| Méthode | Modificateurs | Description |
|---|---|---|
| avecConvertisseur(convertisseur) | 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 . | |
| avecConvertisseur(convertisseur) | Supprime le convertisseur actuel. |
DocumentReference.converter
S'il est fourni, le FirestoreDataConverter associé à cette instance.
Signature:
readonly converter: FirestoreDataConverter<AppModelType, DbModelType> | 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<AppModelType, DbModelType>;
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<NewAppModelType, NewDbModelType extends DocumentData = DocumentData>(converter: FirestoreDataConverter<NewAppModelType, NewDbModelType>): DocumentReference<NewAppModelType, NewDbModelType>;
Paramètres
| Paramètre | Taper | Description |
|---|---|---|
| convertisseur | Convertisseur de données Firestore <NewAppModelType, NewDbModelType> | Convertit les objets vers et depuis Firestore. |
Retour:
Référence de document <NewAppModelType, NewDbModelType>
DocumentReference qui utilise le convertisseur fourni.
DocumentReference.withConverter()
Supprime le convertisseur actuel.
Signature:
withConverter(converter: null): DocumentReference<DocumentData, DocumentData>;
Paramètres
| Paramètre | Taper | Description |
|---|---|---|
| convertisseur | nul | null supprime le convertisseur actuel. |
Retour:
Référence de document < DocumentDonnées , DocumentData >
DocumentReference<DocumentData, DocumentData> qui n'utilise pas de convertisseur.