Query class

Uma Query refere-se a uma consulta que você pode ler ou detectar. Também é possível 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)()		Cria uma nova instância da classe Query

Propriedades

Propriedade	Modificadores	Tipo	Descrição
conversor		FirestoreDataConverter<AppModelType, DBMModelType> | nulo	Se fornecido, o FirestoreDataConverter associado a essa instância.
firestore		Firestore	A instância Firestore do banco de dados do Firestore, que é útil para executar transações etc.
type		"query" | "coleção"	O tipo desta referência do Firestore.

Métodos

Método	Modificadores	Descrição
withConverter(conversor)		Remove o conversor atual.
withConverter(conversor)		Aplica um conversor de dados personalizado a essa consulta, permitindo que você use seus próprios objetos de modelo personalizado com o Firestore. Quando você chama getDocs() com a consulta retornada, o conversor fornecido fará a conversão entre os dados do Firestore do tipo NewDbModelType e seu tipo personalizado NewAppModelType.

Query.(construtor)

Cria uma nova instância da classe Query

Assinatura:

protected constructor();

Query.converter

Se fornecido, o FirestoreDataConverter associado a essa instância.

Assinatura:

readonly converter: FirestoreDataConverter<AppModelType, DbModelType> | null;

Query.firestore

A instância Firestore do banco de dados do Firestore, que é útil para executar transações etc.

Assinatura:

readonly firestore: Firestore;

Tipo de consulta

O tipo desta referência do Firestore.

Assinatura:

readonly type: 'query' | 'collection';

Query.withConverter()

Remove o conversor atual.

Assinatura:

withConverter(converter: null): Query<DocumentData, DocumentData>;

Parâmetros

Parâmetro	Tipo	Descrição
converter	null	null remove o conversor atual.

Retorna:

Consulta<DocumentData, DocumentData>

Uma Query<DocumentData, DocumentData> que não usa um conversor.

Query.withConverter()

Aplica um conversor de dados personalizado a essa consulta, permitindo que você use seus próprios objetos de modelo personalizado com o Firestore. Quando você chama getDocs() com a consulta retornada, o conversor fornecido fará a conversão entre os 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
converter	FirestoreDataConverter<NewAppModelType, NewDbModelType>	Converte objetos no Firestore e a partir dele.

Retorna:

Consulta<NewAppModelType, NewDbModelType>

Um Query que usa o conversor fornecido.