Query class

Queryは、読んだり聞いたりできるクエリを指します。フィルターや順序を追加して、洗練されたQueryオブジェクトを構築することもできます。

サイン：

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

コンストラクター

コンストラクタ	修飾子	説明
（コンストラクタ）（）		Queryクラスの新しいインスタンスを構築します。

プロパティ

財産	修飾子	タイプ	説明
コンバータ		FirestoreDataConverter <AppModelType、DbModelType> |ヌル	指定された場合、このインスタンスに関連付けられたFirestoreDataConverter 。
消防署		ファイヤーストア	Firestore データベースのFirestoreインスタンス (トランザクションの実行などに役立ちます)。
タイプ		'クエリ' | 'コレクション'	この Firestore 参照のタイプ。

メソッド

方法	修飾子	説明
withConverter(コンバーター)		電流コンバータを取り外します。
withConverter(コンバーター)		カスタム データ コンバータをこのクエリに適用し、Firestore で独自のカスタム モデル オブジェクトを使用できるようにします。返されたクエリでgetDocs()を呼び出すと、提供されたコンバーターは、タイプNewDbModelTypeの Firestore データとカスタム タイプNewAppModelTypeの間で変換を行います。

クエリ。(コンストラクター)

Queryクラスの新しいインスタンスを構築します。

サイン：

protected constructor();

クエリコンバータ

指定された場合、このインスタンスに関連付けられたFirestoreDataConverter 。

サイン：

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

Query.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>;

パラメーター

パラメータ	タイプ	説明
コンバータ	FirestoreDataConverter <NewAppModelType、NewDbModelType>	Firestore との間でオブジェクトを変換します。

戻り値：

クエリ<NewAppModelType、NewDbModelType>

提供されたコンバータを使用するQuery 。