Une Query
fait référence à une requête que vous pouvez lire ou écouter. Vous pouvez également créer des objets Query
affinés en ajoutant des filtres et en les classant.
Signature:
export declare class Query<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData>
Constructeurs
Constructeur | Modificateurs | Description |
---|---|---|
(constructeur)() | Construit une nouvelle instance de la classe Query |
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 pour la base de données Firestore (utile pour effectuer des transactions, etc.). | |
taper | 'requête' | 'collection' | Le type de cette référence Firestore. |
Méthodes
Méthode | Modificateurs | Description |
---|---|---|
avecConvertisseur(convertisseur) | Supprime le convertisseur actuel. | |
avecConvertisseur(convertisseur) | Applique un convertisseur de données personnalisé à cette requête, vous permettant d'utiliser vos propres objets de modèle personnalisés avec Firestore. Lorsque vous appelez getDocs() avec la requête renvoyée, le convertisseur fourni convertira entre les données Firestore de type NewDbModelType et votre type personnalisé NewAppModelType . |
Requête. (constructeur)
Construit une nouvelle instance de la classe Query
Signature:
protected constructor();
Requête.convertisseur
S'il est fourni, le FirestoreDataConverter
associé à cette instance.
Signature:
readonly converter: FirestoreDataConverter<AppModelType, DbModelType> | null;
Requête.firestore
L'instance Firestore
pour la base de données Firestore (utile pour effectuer des transactions, etc.).
Signature:
readonly firestore: Firestore;
Requête.type
Le type de cette référence Firestore.
Signature:
readonly type: 'query' | 'collection';
Requête.withConverter()
Supprime le convertisseur actuel.
Signature:
withConverter(converter: null): Query<DocumentData, DocumentData>;
Paramètres
Paramètre | Taper | Description |
---|---|---|
convertisseur | nul | null supprime le convertisseur actuel. |
Retour:
Requête < DocumentDonnées , DocumentData >
Une Query<DocumentData, DocumentData>
qui n'utilise pas de convertisseur.
Requête.withConverter()
Applique un convertisseur de données personnalisé à cette requête, vous permettant d'utiliser vos propres objets de modèle personnalisés avec Firestore. Lorsque vous appelez getDocs() avec la requête 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>): Query<NewAppModelType, NewDbModelType>;
Paramètres
Paramètre | Taper | Description |
---|---|---|
convertisseur | Convertisseur de données Firestore <NewAppModelType, NewDbModelType> | Convertit les objets vers et depuis Firestore. |
Retour:
Requête <NewAppModelType, NewDbModelType>
Une Query
qui utilise le convertisseur fourni.