Un objet CollectionReference peut être utilisé pour ajouter des documents, obtenir des références de documents et interroger des documents (à l'aide de query(). ).
Signature:
export declare class CollectionReference<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData> extends Query<AppModelType, DbModelType>
Extension : requête <AppModelType, DbModelType>
Propriétés
| Propriété | Modificateurs | Taper | Description |
|---|---|---|---|
| identifiant | chaîne | L'identifiant de la collection. | |
| parent | Référence de document < DocumentDonnées , DocumentData > | nul | Une référence au DocumentReference contenant s’il s’agit d’une sous-collection. S'il ne s'agit pas d'une sous-collection, la référence est nulle. | |
| chemin | chaîne | Une chaîne représentant le chemin de la collection référencée (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 CollectionReference , vous permettant d'utiliser vos propres objets de modèle personnalisés avec Firestore. Lorsque vous appelez addDoc() avec l'instance CollectionReference 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. |
CollectionReference.id
L'identifiant de la collection.
Signature:
get id(): string;
CollectionReference.parent
Une référence au DocumentReference contenant s’il s’agit d’une sous-collection. S'il ne s'agit pas d'une sous-collection, la référence est nulle.
Signature:
get parent(): DocumentReference<DocumentData, DocumentData> | null;
CollectionReference.path
Une chaîne représentant le chemin de la collection référencée (par rapport à la racine de la base de données).
Signature:
get path(): string;
CollectionReference.type
Le type de cette référence Firestore.
Signature:
readonly type = "collection";
CollectionReference.withConverter()
Applique un convertisseur de données personnalisé à cette CollectionReference , vous permettant d'utiliser vos propres objets de modèle personnalisés avec Firestore. Lorsque vous appelez addDoc() avec l'instance CollectionReference 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>): CollectionReference<NewAppModelType, NewDbModelType>;
Paramètres
| Paramètre | Taper | Description |
|---|---|---|
| convertisseur | Convertisseur de données Firestore <NewAppModelType, NewDbModelType> | Convertit les objets vers et depuis Firestore. |
Retour:
CollectionRéférence <NewAppModelType, NewDbModelType>
CollectionReference qui utilise le convertisseur fourni.
CollectionReference.withConverter()
Supprime le convertisseur actuel.
Signature:
withConverter(converter: null): CollectionReference<DocumentData, DocumentData>;
Paramètres
| Paramètre | Taper | Description |
|---|---|---|
| convertisseur | nul | null supprime le convertisseur actuel. |
Retour:
CollectionRéférence < DocumentDonnées , DocumentData >
CollectionReference<DocumentData, DocumentData> qui n'utilise pas de convertisseur.