Query class

Query 是指您可以读取或监听的查询。您还可以通过添加过滤条件和排序来构建经过优化的 Query 对象。

签名：

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

构造函数

构造函数	修饰符	说明
(构造函数)()		构造 Query 类的新实例

属性

属性	修饰符	类型	说明
转化者		FirestoreDataConverter<AppModelType, DbModelType>|null	与此实例关联的 FirestoreDataConverter（如果提供）。
firestore		Firestore	Firestore 数据库的 Firestore 实例（用于执行事务等）。
type		“查询”|“collection”	此 Firestore 引用的类型。

方法

方法	修饰符	说明
withConverter(converter)		移除当前转换器。
withConverter(converter)		对此查询应用自定义数据转换器，从而将自己的自定义模型对象用于 Firestore。当您使用返回的查询调用 getDocs() 时，提供的转换器将在 NewDbModelType 类型的 Firestore 数据与您的自定义类型 NewAppModelType 之间进行转换。

Query.（构造函数）

构造 Query 类的新实例

签名：

protected constructor();

Query.converter

与此实例关联的 FirestoreDataConverter（如果提供）。

签名：

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

Query.firestore

Firestore 数据库的 Firestore 实例（用于执行事务等）。

签名：

readonly firestore: Firestore;

Query.type

此 Firestore 引用的类型。

签名：

readonly type: 'query' | 'collection';

Query.withConverter()

移除当前转换器。

签名：

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

参数

参数	类型	说明
converter	null	null 可移除当前转换器。

返回：

查询<DocumentData, DocumentData>

不使用转换器的 Query<DocumentData, DocumentData>。

Query.withConverter()

对此查询应用自定义数据转换器，从而将自己的自定义模型对象用于 Firestore。当您使用返回的查询调用 getDocs() 时，提供的转换器将在 NewDbModelType 类型的 Firestore 数据与您的自定义类型 NewAppModelType 之间进行转换。

签名：

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

参数

参数	类型	说明
converter	FirestoreDataConverter<NewAppModelType, NewDbModelType>	在 Firestore 之间转换对象。

返回：

查询<NewAppModelType, NewDbModelType>

使用所提供的转换器的 Query。