DocumentSnapshot class

DocumentSnapshot에는 Firestore 데이터베이스의 문서에서 읽은 데이터가 포함됩니다. .data() 또는 .get(<field>)로 데이터를 추출하여 특정 필드를 가져올 수 있습니다.

존재하지 않는 문서를 가리키는 DocumentSnapshot의 경우 데이터 액세스는 '정의되지 않음'을 반환합니다. exists() 메서드를 사용하여 문서가 있는지 명시적으로 확인할 수 있습니다.

서명:

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

생성자

생성자 특수키 설명
(생성자)() DocumentSnapshot 클래스의 새 인스턴스를 생성합니다.

속성

속성 특수키 유형 설명
id 문자열 문서의 ID를 제공하는 DocumentSnapshot의 속성입니다.
메타데이터 SnapshotMetadata 소스 및 로컬 수정사항에 관한 정보를 포함한 DocumentSnapshot에 관한 메타데이터입니다.
참조 DocumentReference<AppModelType, DBMModelType> DocumentSnapshot에 포함된 문서의 DocumentReference

메소드

메서드 특수키 설명
데이터(옵션) 문서의 모든 필드를 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, DBMModelType>입니다.

DocumentSnapshot.get()

fieldPath로 지정된 필드를 검색합니다. 문서나 필드가 없으면 undefined를 반환합니다.

기본적으로 아직 최종 값으로 설정되지 않은 serverTimestamp()는 null로 반환됩니다. 옵션 객체를 전달하여 재정의할 수 있습니다.

서명:

get(fieldPath: string | FieldPath, options?: SnapshotOptions): any;

매개변수

매개변수 유형 설명
fieldPath 문자열 | FieldPath 특정 필드의 경로 (예: 'foo' 또는 'foo.bar')입니다.
옵션 SnapshotOptions 스냅샷에서 필드를 가져오는 방식을 구성하는 옵션 객체입니다 (예: 아직 최종 값으로 설정되지 않은 서버 타임스탬프에 대해 원하는 동작).

반환:

모두

지정된 필드 위치에 있는 데이터이며, 문서에 이러한 필드가 없는 경우 정의되지 않습니다.