Query class

Query是指您可以阅读或收听的查询。您还可以通过添加过滤器和排序来构造精炼的Query对象。

签名:

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

构造函数

构造函数修饰符描述
(构造函数)()构造Query类的新实例

特性

财产修饰符类型描述
转换器Firestore数据转换器<AppModelType,DbModelType> |无效的如果提供,则为与此实例关联的FirestoreDataConverter
火库火库Firestore 数据库的Firestore实例(用于执行事务等)。
类型'查询' | '收藏'此 Firestore 引用的类型。

方法

方法修饰符描述
与转换器(转换器)移除电流转换器。
与转换器(转换器)对此查询应用自定义数据转换器,允许您将自己的自定义模型对象与 Firestore 结合使用。当您使用返回的查询调用getDocs()时,提供的转换器将在NewDbModelType类型的 Firestore 数据和您的自定义类型NewAppModelType之间进行转换。

查询。(构造函数)

构造Query类的新实例

签名:

protected constructor();

查询转换器

如果提供,则为与此实例关联的FirestoreDataConverter

签名:

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

查询.firestore

Firestore 数据库的Firestore实例(用于执行事务等)。

签名:

readonly firestore: Firestore;

查询类型

此 Firestore 引用的类型。

签名:

readonly type: 'query' | 'collection';

Query.withConverter()

移除电流转换器。

签名:

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

参数

范围类型描述
转换器无效的null删除当前转换器。

返回:

询问<文档数据,文档数据>

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

Query.withConverter()

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

签名:

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

参数

范围类型描述
转换器Firestore数据转换器<新应用程序模型类型、新数据库模型类型>将对象与 Firestore 相互转换。

返回:

询问<新应用程序模型类型、新数据库模型类型>

使用提供的转换器的Query