DocumentSnapshot에는 Firestore 데이터베이스의 문서에서 읽은 데이터가 포함됩니다. .data() 또는 .get(<field>)로 데이터를 추출하여 특정 필드를 가져올 수 있습니다.
존재하지 않는 문서를 가리키는 DocumentSnapshot의 경우 데이터 액세스는 '정의되지 않음'을 반환합니다. exists() 메서드를 사용하여 문서가 있는지 명시적으로 확인할 수 있습니다.
서명:
export declare class DocumentSnapshot<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData>
생성자
| 생성자 | 특수키 | 설명 |
|---|---|---|
| (생성자)() | DocumentSnapshot 클래스의 새 인스턴스를 생성합니다. |
속성
| 속성 | 특수키 | 유형 | 설명 |
|---|---|---|---|
| id | 문자열 | 문서의 ID를 제공하는 DocumentSnapshot의 속성입니다. |
|
| 참조 | DocumentReference<AppModelType, DBMModelType> | DocumentSnapshot에 포함된 문서의 DocumentReference |
메소드
| 메서드 | 특수키 | 설명 |
|---|---|---|
| 데이터() | 문서의 모든 필드를 Object로 검색합니다. 문서가 없으면 undefined를 반환합니다. |
|
| exists() | 스냅샷 위치에 있는 문서가 존재하는지 여부를 나타냅니다. | |
| get(fieldPath) | fieldPath로 지정된 필드를 검색합니다. 문서나 필드가 없으면 undefined를 반환합니다. |
DocumentSnapshot.(생성자)
DocumentSnapshot 클래스의 새 인스턴스를 생성합니다.
서명:
protected constructor();
DocumentSnapshot.id
문서의 ID를 제공하는 DocumentSnapshot의 속성입니다.
서명:
get id(): string;
DocumentSnapshot.ref
DocumentSnapshot에 포함된 문서의 DocumentReference입니다.
서명:
get ref(): DocumentReference<AppModelType, DbModelType>;
DocumentSnapshot.data()
문서의 모든 필드를 Object로 검색합니다. 문서가 없으면 undefined를 반환합니다.
서명:
data(): AppModelType | undefined;
반환:
AppModelType | 정의되지 않음
문서의 모든 필드를 포함하는 Object 또는 문서가 존재하지 않는 경우 undefined
DocumentSnapshot.exists()
스냅샷 위치에 있는 문서가 존재하는지 여부를 나타냅니다.
서명:
exists(): this is QueryDocumentSnapshot<AppModelType, DbModelType>;
반환:
QueryDocumentSnapshot<AppModelType, DBMModelType>입니다.
문서가 있으면 true를 반환합니다.
DocumentSnapshot.get()
fieldPath로 지정된 필드를 검색합니다. 문서나 필드가 없으면 undefined를 반환합니다.
서명:
get(fieldPath: string | FieldPath): any;
매개변수
| 매개변수 | 유형 | 설명 |
|---|---|---|
| fieldPath | 문자열 | FieldPath | 특정 필드의 경로 (예: 'foo' 또는 'foo.bar')입니다. |
반환:
모두
지정된 필드 위치에 있는 데이터이며, 문서에 이러한 필드가 없는 경우 정의되지 않습니다.