Una Query se refiere a una consulta que puede leer o escuchar. También puede construir objetos Query refinados agregando filtros y ordenándolos.
Firma:
export declare class Query<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData>
Constructores
| Constructor | Modificadores | Descripción |
|---|---|---|
| (constructor)() | Construye una nueva instancia de la clase Query |
Propiedades
| Propiedad | Modificadores | Tipo | Descripción |
|---|---|---|---|
| convertidor | FirestoreDataConverter <AppModelType, DbModelType> | nulo | Si se proporciona, el FirestoreDataConverter asociado con esta instancia. | |
| tienda de fuego | Tienda de fuego | La instancia Firestore para la base de datos de Firestore (útil para realizar transacciones, etc.). | |
| tipo | 'consulta' | 'recopilación' | El tipo de esta referencia de Firestore. |
Métodos
| Método | Modificadores | Descripción |
|---|---|---|
| conConvertidor(convertidor) | Elimina el convertidor actual. | |
| conConvertidor(convertidor) | Aplica un convertidor de datos personalizado a esta consulta, lo que le permite usar sus propios objetos de modelo personalizados con Firestore. Cuando llamas a getDocs() con la consulta devuelta, el convertidor proporcionado convertirá entre datos de Firestore de tipo NewDbModelType y tu tipo personalizado NewAppModelType . |
Consulta.(constructor)
Construye una nueva instancia de la clase Query
Firma:
protected constructor();
Convertidor de consultas
Si se proporciona, el FirestoreDataConverter asociado con esta instancia.
Firma:
readonly converter: FirestoreDataConverter<AppModelType, DbModelType> | null;
Consulta.firestore
La instancia Firestore para la base de datos de Firestore (útil para realizar transacciones, etc.).
Firma:
readonly firestore: Firestore;
Tipo de consulta
El tipo de esta referencia de Firestore.
Firma:
readonly type: 'query' | 'collection';
Consulta.withConverter()
Elimina el convertidor actual.
Firma:
withConverter(converter: null): Query<DocumentData, DocumentData>;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| convertidor | nulo | null elimina el convertidor actual. |
Devoluciones:
Consulta < DocumentoDatos , Datos del documento >
Una Query<DocumentData, DocumentData> que no utiliza un convertidor.
Consulta.withConverter()
Aplica un convertidor de datos personalizado a esta consulta, lo que le permite usar sus propios objetos de modelo personalizados con Firestore. Cuando llamas a getDocs() con la consulta devuelta, el convertidor proporcionado convertirá entre los datos de Firestore de 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 |
|---|---|---|
| convertidor | FirestoreDataConverter <Nuevo tipo de modelo de aplicación, nuevo tipo de modelo de base de datos> | Convierte objetos hacia y desde Firestore. |
Devoluciones:
Consulta <Nuevo tipo de modelo de aplicación, nuevo tipo de modelo de base de datos>
Una Query que utiliza el convertidor proporcionado.