CollectionReference class

CollectionReferenceオブジェクトは、ドキュメントの追加、ドキュメント参照の取得、およびドキュメントのクエリ ( query()を使用) に使用できます。 ）。

サイン：

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

拡張:クエリ<AppModelType、DbModelType>

プロパティ

メソッド

CollectionReference.id

コレクションの識別子。

サイン：

get id(): string;

CollectionReference.parent

これがサブコレクションの場合、含まれるDocumentReferenceへの参照。これがサブコレクションではない場合、参照は null です。

サイン：

get parent(): DocumentReference<DocumentData, DocumentData> | null;

CollectionReference.path

参照されるコレクションのパス (データベースのルートからの相対パス) を表す文字列。

サイン：

get path(): string;

CollectionReference.type

この Firestore 参照のタイプ。

サイン：

readonly type = "collection";

CollectionReference.withConverter()

カスタム データ コンバータをこのCollectionReferenceに適用しますを使用すると、Firestore で独自のカスタム モデル オブジェクトを使用できるようになります。返されたCollectionReferenceインスタンスを使用してaddDoc()を呼び出すと、提供されたコンバーターによって、タイプNewDbModelTypeの Firestore データとカスタム タイプNewAppModelTypeの間で変換が行われます。 。

サイン：

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

パラメーター

戻り値：

コレクションリファレンス<NewAppModelType、NewDbModelType>

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

CollectionReference.withConverter()

電流コンバータを取り外します。

サイン：

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

パラメーター

戻り値：

コレクションリファレンス<ドキュメントデータ、ドキュメントデータ>

コンバータを使用しないCollectionReference<DocumentData, DocumentData> 。