DocumentSnapshot class

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

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

서명:

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

생성자

속성

행동 양식

DocumentSnapshot.(생성자)

DocumentSnapshot 클래스의 새 인스턴스를 생성합니다.

서명:

protected constructor();

문서스냅샷.id

문서의 ID를 제공하는 DocumentSnapshot 의 속성입니다.

서명:

get id(): string;

문서스냅샷.메타데이터

DocumentSnapshot 에 대한 메타데이터 , 소스 및 로컬 수정 사항에 대한 정보를 포함합니다.

서명:

readonly metadata: SnapshotMetadata;

문서스냅샷.ref

DocumentSnapshot 에 포함된 문서에 대한 DocumentReference .

서명:

get ref(): DocumentReference<AppModelType, DbModelType>;

DocumentSnapshot.data()

문서의 모든 필드를 Object 로 검색합니다. . 문서가 존재하지 않으면 undefined 반환합니다.

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

서명:

data(options?: SnapshotOptions): AppModelType | undefined;

매개변수

보고:

앱모델 유형 | 한정되지 않은

문서의 모든 필드를 포함하는 개체이거나 문서가 존재하지 않는 경우 undefined Object 입니다.

DocumentSnapshot.exists()

데이터가 존재하는지 여부를 반환합니다. 문서가 존재하면 참입니다.

서명:

exists(): this is QueryDocumentSnapshot<AppModelType, DbModelType>;

보고:

이것은 QueryDocumentSnapshot 입니다. <AppModelType, DbModelType>

DocumentSnapshot.get()

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

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

서명:

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

매개변수

보고:

어느

지정된 필드 위치에 있는 데이터입니다. 문서에 해당 필드가 없으면 정의되지 않습니다.