DocumentReference class

DocumentReference は Firestore データベース内のドキュメントの場所を参照し、場所の書き込み、読み取り、リッスンに使用できます。参照先の場所にドキュメントが存在する場合と存在しない場合があります。

署名:

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

プロパティ

プロパティ	修飾キー	タイプ	説明
コンバータ		FirestoreDataConverter<AppModelType、DbModelType>|null	指定する場合は、このインスタンスに関連付けられている FirestoreDataConverter。
firestore		Firestore	ドキュメントが存在する Firestore インスタンス。これは、トランザクションの実行などに役立ちます。
id		文字列	コレクション内のドキュメントの識別子。
parent		CollectionReference<AppModelType、DbModelType>	この DocumentReference が属するコレクション。
path		文字列	参照先ドキュメントのパス（データベースのルートからの相対パス）を表す文字列。
type		（未申告）	この Firestore 参照のタイプ。

メソッド

メソッド	修飾キー	説明
withConverter(converter)		この DocumentReference にカスタムデータ コンバータを適用し、Firestore で独自のカスタムモデル オブジェクトを使用できるようにします。返された DocumentReference インスタンスで setDoc() や getDoc() などを呼び出すと、提供されたコンバータが NewDbModelType 型とカスタム型 NewAppModelType の Firestore データを変換します。
withConverter(converter)		現在のコンバータを削除します。

DocumentReference.converter

指定する場合は、このインスタンスに関連付けられている FirestoreDataConverter。

署名:

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

DocumentReference.firestore

ドキュメントが存在する Firestore インスタンス。これは、トランザクションの実行などに役立ちます。

署名:

readonly firestore: Firestore;

DocumentReference.id

コレクション内のドキュメントの識別子。

署名:

get id(): string;

DocumentReference.parent

この DocumentReference が属するコレクション。

署名:

get parent(): CollectionReference<AppModelType, DbModelType>;

DocumentReference.path

参照先ドキュメントのパス（データベースのルートからの相対パス）を表す文字列。

署名:

get path(): string;

DocumentReference.type

この Firestore 参照のタイプ。

署名:

readonly type = "document";

DocumentReference.withConverter()

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

署名:

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

パラメータ

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

戻り値:

DocumentReference<NewAppModelType、NewDbModelType>

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

DocumentReference.withConverter()

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

署名:

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

パラメータ

パラメータ	型	説明
converter	null	null は現在のコンバータを削除します。

戻り値:

DocumentReference<DocumentData、DocumentData>

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