AQuery refers to a query which you can read or listen to. You can also construct refinedQuery objects by adding filters and ordering.

Signature:

exportdeclareclassQuery<AppModelType=DocumentData,DbModelTypeextendsDocumentData=DocumentData>

Constructors

Properties

Methods

Query.(constructor)

Constructs a new instance of theQuery class

Signature:

protectedconstructor();

Query.converter

If provided, theFirestoreDataConverter associated with this instance.

Signature:

readonlyconverter:FirestoreDataConverter<AppModelType,DbModelType>|null;

Query.firestore

TheFirestore instance for the Firestore database (useful for performing transactions, etc.).

Signature:

readonlyfirestore:Firestore;

Query.type

The type of this Firestore reference.

Signature:

readonlytype:'query'|'collection';

Query.withConverter()

Removes the current converter.

Signature:

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

Parameters

Returns:

Query<DocumentData,DocumentData>

AQuery<DocumentData, DocumentData> that does not use a converter.

Query.withConverter()

Applies a custom data converter to this query, allowing you to use your own custom model objects with Firestore. When you callgetDocs() with the returned query, the provided converter will convert between Firestore data of typeNewDbModelType and your custom typeNewAppModelType.

Signature:

withConverter<NewAppModelType,NewDbModelTypeextendsDocumentData=DocumentData>(converter:FirestoreDataConverter<NewAppModelType,NewDbModelType>):Query<NewAppModelType,NewDbModelType>;

Parameters

Returns:

Query<NewAppModelType, NewDbModelType>

AQuery that uses the provided converter.