Un Query hace referencia a una consulta que puedes leer o escuchar. También puedes crear objetos Query refinados agregando filtros y ordenando.
Firma:
export declare class Query<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData>
Constructores
| Constructor | Teclas modificadoras | Descripción |
|---|---|---|
| (constructor)() | Construye una instancia nueva de la clase Query. |
Propiedades
| Propiedad | Teclas modificadoras | Tipo | Descripción |
|---|---|---|---|
| convertidor | FirestoreDataConverter<AppModelType, DBMModelType> | nulo | Si se proporciona, el FirestoreDataConverter asociado con esta instancia. |
|
| Firestore | Firestore | La instancia Firestore de la base de datos de Firestore (útil para realizar transacciones, etcétera) |
|
| tipo | "consulta" | 'colección' | El tipo de esta referencia de Firestore. |
Métodos
| Método | Teclas modificadoras | Descripción |
|---|---|---|
| withConverter(converter) | Quita el conversor actual. | |
| withConverter(converter) | Aplica un convertidor de datos personalizado a esta consulta, lo que te permite usar tus propios objetos de modelo personalizado con Firestore. Cuando llames a getDocs() con la consulta que se muestra, el conversor proporcionado convertirá los datos de Firestore del tipo NewDbModelType y tu tipo personalizado NewAppModelType. |
Consulta.(constructor)
Construye una instancia nueva de la clase Query.
Firma:
protected constructor();
Convertidor de consulta
Si se proporciona, el FirestoreDataConverter asociado con esta instancia.
Firma:
readonly converter: FirestoreDataConverter<AppModelType, DbModelType> | null;
Query.firestore
La instancia Firestore de la base de datos de Firestore (útil para realizar transacciones, etcétera)
Firma:
readonly firestore: Firestore;
Tipo de consulta
El tipo de esta referencia de Firestore.
Firma:
readonly type: 'query' | 'collection';
Query.withConverter()
Quita el conversor actual.
Firma:
withConverter(converter: null): Query<DocumentData, DocumentData>;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| converter | null | null quita el conversor actual. |
Muestra:
Consulta<DocumentData, DocumentData>
Es un objeto Query<DocumentData, DocumentData> que no usa un convertidor.
Query.withConverter()
Aplica un convertidor de datos personalizado a esta consulta, lo que te permite usar tus propios objetos de modelo personalizado con Firestore. Cuando llames a getDocs() con la consulta que se muestra, el conversor proporcionado convertirá los datos de Firestore del tipo NewDbModelType y tu tipo personalizado NewAppModelType.
Firma:
withConverter<NewAppModelType, NewDbModelType extends DocumentData = DocumentData>(converter: FirestoreDataConverter<NewAppModelType, NewDbModelType>): Query<NewAppModelType, NewDbModelType>;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| converter | FirestoreDataConverter<NewAppModelType, NewDbModelType> | Convierte objetos hacia y desde Firestore. |
Muestra:
Consulta<NewAppModelType, NewDbModelType>
Un objeto Query que usa el convertidor proporcionado