Query class

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

Signature:

export declare class Query<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData> 

Constructors

Properties

Methods

Query.(constructor)

Constructs a new instance of the Query class

Signature:

protected constructor();

Query.converter

If provided, the FirestoreDataConverter associated with this instance.

Signature:

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

Query.firestore

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

Signature:

readonly firestore: Firestore;

Query.type

The type of this Firestore reference.

Signature:

readonly type: 'query' | 'collection';

Query.withConverter()

Removes the current converter.

Signature:

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

Parameters

Returns:

Query<DocumentData, DocumentData>

A Query<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 call getDocs() with the returned query, the provided converter will convert between Firestore data of type NewDbModelType and your custom type NewAppModelType.

Signature:

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

Parameters

Returns:

Query<NewAppModelType, NewDbModelType>

A Query that uses the provided converter.