CollectionReference class

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

署名:

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

拡張: Query<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>;

パラメータ

戻り値:

CollectionReference<NewAppModelType、NewDbModelType>

指定されたコンバータを使用する CollectionReference。

CollectionReference.withConverter()

現在のコンバータを削除します。

署名:

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

パラメータ

戻り値:

CollectionReference<DocumentData、DocumentData>

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