DocumentSnapshot には、Firestore データベースのドキュメントから読み取られたデータが含まれます。特定のフィールドを取得するには、.data() または .get(<field>) を使用してデータを抽出できます。
存在しないドキュメントを指す DocumentSnapshot の場合、データアクセスを行うと「未定義」が返されます。exists() メソッドを使用して、ドキュメントの存在を明示的に確認できます。
署名:
export declare class DocumentSnapshot<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData>
コンストラクタ
| コンストラクタ | 修飾キー | 説明 |
|---|---|---|
| (structor)() | DocumentSnapshot クラスの新しいインスタンスを作成します。 |
プロパティ
| プロパティ | 修飾キー | タイプ | 説明 |
|---|---|---|---|
| id | 文字列 | ドキュメントの ID を提供する DocumentSnapshot のプロパティ。 |
|
| metadata | SnapshotMetadata | DocumentSnapshot に関するメタデータ（ソースとローカルの変更に関する情報を含む）。 |
|
| 参照 | DocumentReference<AppModelType、DbModelType> | DocumentSnapshot に含まれるドキュメントの DocumentReference。 |
メソッド
| メソッド | 修飾キー | 説明 |
|---|---|---|
| data(options) | ドキュメント内のすべてのフィールドを Object として取得します。ドキュメントが存在しない場合は undefined を返します。デフォルトでは、最終値に設定されていない serverTimestamp() 値は null として返されます。これをオーバーライドするには、オプション オブジェクトを渡します。 |
|
| exists() | データが存在するかどうかを返します。ドキュメントが存在する場合は true。 | |
| get(fieldPath, options) | fieldPath で指定されたフィールドを取得します。ドキュメントまたはフィールドが存在しない場合は undefined を返します。デフォルトでは、最終値に設定されていない serverTimestamp() は null として返されます。これをオーバーライドするには、オプション オブジェクトを渡します。 |
DocumentSnapshot.(コンストラクタ)
DocumentSnapshot クラスの新しいインスタンスを作成します。
署名:
protected constructor();
DocumentSnapshot.id
ドキュメントの ID を提供する DocumentSnapshot のプロパティ。
署名:
get id(): string;
DocumentSnapshot.metadata
DocumentSnapshot に関するメタデータ（ソースとローカルの変更に関する情報を含む）。
署名:
readonly metadata: SnapshotMetadata;
DocumentSnapshot.ref
DocumentSnapshot に含まれるドキュメントの DocumentReference。
署名:
get ref(): DocumentReference<AppModelType, DbModelType>;
DocumentSnapshot.data()
ドキュメント内のすべてのフィールドを Object として取得します。ドキュメントが存在しない場合は undefined を返します。
デフォルトでは、最終的な値に設定されていない serverTimestamp() 値は null として返されます。これをオーバーライドするには、オプション オブジェクトを渡します。
署名:
data(options?: SnapshotOptions): AppModelType | undefined;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| オプション | SnapshotOptions | スナップショットからデータを取得する方法（最終的な値にまだ設定されていないサーバーのタイムスタンプに対する望ましい動作など）を構成するオプション オブジェクト。 |
戻り値:
AppModelType |未定義
ドキュメント内のすべてのフィールドを含む Object。ドキュメントが存在しない場合は undefined。
DocumentSnapshot.exists()
データが存在するかどうかを返します。ドキュメントが存在する場合は true。
署名:
exists(): this is QueryDocumentSnapshot<AppModelType, DbModelType>;
戻り値:
これは QueryDocumentSnapshot です<AppModelType, DbModelType>
DocumentSnapshot.get()
fieldPath で指定されたフィールドを取得します。ドキュメントまたはフィールドが存在しない場合は undefined を返します。
デフォルトでは、まだ最終的な値に設定されていない serverTimestamp() は null として返されます。これをオーバーライドするには、オプション オブジェクトを渡します。
署名:
get(fieldPath: string | FieldPath, options?: SnapshotOptions): any;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| fieldPath | 文字列 |FieldPath | 特定のフィールドへのパス（「foo」や「foo.bar」など）。 |
| オプション | SnapshotOptions | スナップショットからフィールドを取得する方法を構成するオプション オブジェクト（たとえば、最終的な値に設定されていないサーバーのタイムスタンプに望ましい動作など）。 |
戻り値:
任意
指定されたフィールドの場所のデータ。ドキュメント内にそのようなフィールドが存在しない場合は未定義のデータ。