Query は、読み取りやリッスンが可能なクエリを指します。フィルタと順序を追加して、絞り込んだ Query オブジェクトを作成することもできます。
署名:
export declare class Query<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData>
コンストラクタ
| コンストラクタ | 修飾キー | 説明 |
|---|---|---|
| (structor)() | Query クラスの新しいインスタンスを作成します。 |
プロパティ
| プロパティ | 修飾キー | タイプ | 説明 |
|---|---|---|---|
| コンバータ | FirestoreDataConverter<AppModelType、DbModelType>|null | 指定する場合は、このインスタンスに関連付けられている FirestoreDataConverter。 |
|
| firestore | Firestore | Firestore データベースの Firestore インスタンス（トランザクションの実行などに便利です）。 |
|
| type | 「query」|「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 は現在のコンバータを削除します。 |
戻り値:
Query<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 との間でオブジェクトを変換します。 |
戻り値:
Query<NewAppModelType、NewDbModelType>
指定されたコンバータを使用する Query。