Uma Query refere-se a uma consulta que você pode ler ou ouvir. Você também pode construir objetos Query refinados adicionando filtros e ordenando.
Assinatura:
export declare class Query<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData>
Construtores
| Construtor | Modificadores | Descrição |
|---|---|---|
| (construtor)() | Constrói uma nova instância da classe Query |
Propriedades
| Propriedade | Modificadores | Tipo | Descrição |
|---|---|---|---|
| conversor | FirestoreDataConverter <AppModelType, DbModelType> | nulo | Se fornecido, o FirestoreDataConverter associado a esta instância. | |
| firestore | Armazém de Fogo | A instância Firestore para o banco de dados Firestore (útil para realizar transações, etc.). | |
| tipo | 'consulta' | 'coleção' | O tipo desta referência do Firestore. |
Métodos
| Método | Modificadores | Descrição |
|---|---|---|
| comConversor(conversor) | Remove o conversor atual. | |
| comConversor(conversor) | Aplica um conversor de dados personalizado a esta consulta, permitindo que você use seus próprios objetos de modelo personalizados com o Firestore. Quando você chama getDocs() com a consulta retornada, o conversor fornecido converte entre dados do Firestore do tipo NewDbModelType e seu tipo personalizado NewAppModelType . |
Consulta.(construtor)
Constrói uma nova instância da classe Query
Assinatura:
protected constructor();
Consulta.conversor
Se fornecido, o FirestoreDataConverter associado a esta instância.
Assinatura:
readonly converter: FirestoreDataConverter<AppModelType, DbModelType> | null;
Consulta.firestore
A instância Firestore para o banco de dados Firestore (útil para realizar transações, etc.).
Assinatura:
readonly firestore: Firestore;
Tipo de consulta
O tipo desta referência do Firestore.
Assinatura:
readonly type: 'query' | 'collection';
Consulta.withConverter()
Remove o conversor atual.
Assinatura:
withConverter(converter: null): Query<DocumentData, DocumentData>;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| conversor | nulo | null remove o conversor atual. |
Retorna:
Consulta < DocumentData , DadosDoDocumento >
Um Query<DocumentData, DocumentData> que não usa um conversor.
Consulta.withConverter()
Aplica um conversor de dados personalizado a esta consulta, permitindo que você use seus próprios objetos de modelo personalizados com o Firestore. Quando você chama getDocs() com a consulta retornada, o conversor fornecido converte entre dados do Firestore do tipo NewDbModelType e seu tipo personalizado NewAppModelType .
Assinatura:
withConverter<NewAppModelType, NewDbModelType extends DocumentData = DocumentData>(converter: FirestoreDataConverter<NewAppModelType, NewDbModelType>): Query<NewAppModelType, NewDbModelType>;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| conversor | FirestoreDataConverter <NewAppModelType, NewDbModelType> | Converte objetos de e para o Firestore. |
Retorna:
Consulta <NewAppModelType, NewDbModelType>
Uma Query que usa o conversor fornecido.