DocumentSnapshotには、Firestore データベース内のドキュメントから読み取られたデータが含まれています。 .data()または.get(<field>)を使用してデータを抽出し、特定のフィールドを取得できます。
存在しないドキュメントを指すDocumentSnapshotの場合、データ アクセスはすべて「未定義」を返します。 exists()メソッドを使用すると、ドキュメントの存在を明示的に確認できます。
サイン：
export declare class DocumentSnapshot<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData>
コンストラクター
| コンストラクタ | 修飾子 | 説明 |
|---|---|---|
| （コンストラクタ）（） | DocumentSnapshotクラスの新しいインスタンスを構築します。 |
プロパティ
| 財産 | 修飾子 | タイプ | 説明 |
|---|---|---|---|
| ID | 弦 | ドキュメントの ID を提供するDocumentSnapshotのプロパティ。 | |
| メタデータ | スナップショットメタデータ | DocumentSnapshotに関するメタデータ。ソースおよびローカル変更に関する情報が含まれます。 | |
| 参照 | ドキュメントリファレンス<AppModelType、DbModelType> | DocumentSnapshotに含まれるドキュメントのDocumentReference 。 |
メソッド
| 方法 | 修飾子 | 説明 |
|---|---|---|
| データ(オプション) | ドキュメント内のすべてのフィールドをObjectとして取得します。ドキュメントが存在しない場合は、 undefined返します。デフォルトでは、まだ最終値に設定されていないserverTimestamp()値はnullとして返されます。オプション オブジェクトを渡すことでこれをオーバーライドできます。 | |
| 存在します() | データが存在するかどうかを返します。ドキュメントが存在する場合は True。 | |
| get(フィールドパス, オプション) | 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;
パラメーター
| パラメータ | タイプ | 説明 |
|---|---|---|
| オプション | スナップショットオプション | スナップショットからデータを取得する方法を構成するオプション オブジェクト (たとえば、最終値がまだ設定されていないサーバーのタイムスタンプの望ましい動作など)。 |
戻り値：
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;
パラメーター
| パラメータ | タイプ | 説明 |
|---|---|---|
| フィールドパス | 文字列 |フィールドパス | 特定のフィールドへのパス (「foo」または「foo.bar」など)。 |
| オプション | スナップショットオプション | スナップショットからフィールドを取得する方法を構成するオプション オブジェクト (たとえば、最終値がまだ設定されていないサーバー タイムスタンプの望ましい動作など)。 |
戻り値：
どれでも
指定されたフィールドの場所にあるデータ、またはドキュメント内にそのようなフィールドが存在しない場合は未定義のデータ。