Query class

Query 是指可以讀取或監聽的查詢。您也可以新增篩選器和排序，建立修正後的 Query 物件。

簽名：

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

建構函式

建構函式	修飾符	說明
(建構函式)()		建構 Query 類別的新例項

屬性

屬性	修飾符	類型	說明
轉換者		FirestoreDataConverter<AppModelType、DBMModelType>|空值	如有提供，就會提供與這個執行個體相關聯的 FirestoreDataConverter。
Firestore		Firestore	Firestore 資料庫的 Firestore 執行個體 (適合用於執行交易等)。
類型		「query」|「collection」	這項 Firestore 參考資料的類型。

方法

方法	修飾符	說明
withConverter(converter)		移除目前的轉換工具。
withConverter(converter)		將自訂資料轉換器套用至這項查詢，您就能透過 Firestore 使用自己的自訂模型物件。當您使用傳回的查詢呼叫 getDoc() 時，提供的轉換工具會在 NewDbModelType 類型的 Firestore 資料和您的自訂類型 NewAppModelType 之間進行轉換。

Query.(建構函式)

建構 Query 類別的新例項

簽名：

protected constructor();

Query.converter

如有提供，就會提供與這個執行個體相關聯的 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>;

參數

參數	類型	說明
converter	null	null 會移除目前的轉換工具。

傳回：

查詢<DocumentData、DocumentData>

不使用轉換器的 Query<DocumentData, DocumentData>。

Query.withConverter()

將自訂資料轉換器套用至這項查詢，您就能透過 Firestore 使用自己的自訂模型物件。當您使用傳回的查詢呼叫 getDoc() 時，提供的轉換工具會在 NewDbModelType 類型的 Firestore 資料和您的自訂類型 NewAppModelType 之間轉換。

簽名：

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

參數

參數	類型	說明
converter	FirestoreDataConverter<NewAppModelType、NewDbModelType>	將物件轉換為 Firestore，或從 Firestore 轉換物件。

傳回：

查詢<NewAppModelType, NewDbModelType>

使用提供的轉換器的 Query。