DocumentReference class

DocumentReference는 Firestore 데이터베이스의 문서 위치를 의미하며 위치를 쓰거나 읽거나 리슨하는 데 사용할 수 있습니다. 참조된 위치에 문서가 있을 수도 있고 없을 수도 있습니다.

서명:

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

속성

속성	특수키	유형	설명
변환기		FirestoreDataConverter<AppModelType, DBMModelType> | 없음	제공되는 경우 이 인스턴스와 연결된 FirestoreDataConverter입니다.
firestore		Firestore	문서가 있는 Firestore 인스턴스 이는 예를 들어 트랜잭션을 수행할 때 유용합니다.
id		문자열	컬렉션 내 문서의 식별자입니다.
parent		CollectionReference<AppModelType, DBMType>	이 DocumentReference이(가) 속한 컬렉션입니다.
경로		문자열	참조 문서의 경로를 나타내는 문자열입니다 (데이터베이스 루트 기준).
type		(선언되지 않음)	이 Firestore 참조의 유형입니다.

메소드

메서드	특수키	설명
withConverter(converter)		이 DocumentReference에 커스텀 데이터 변환기를 적용하여 Firestore에서 자체 커스텀 모델 객체를 사용할 수 있도록 합니다. 반환된 DocumentReference 인스턴스로 setDoc(), getDoc() 등을 호출하면 제공된 변환기가 NewDbModelType 유형의 Firestore 데이터와 NewAppModelType 커스텀 유형 간에 변환합니다.
withConverter(converter)		현재 변환기를 삭제합니다.

DocumentReference.converter

제공되는 경우 이 인스턴스와 연결된 FirestoreDataConverter입니다.

서명:

readonly converter: FirestoreDataConverter<AppModelType, DbModelType> | null;

DocumentReference.firestore

문서가 있는 Firestore 인스턴스 이는 예를 들어 트랜잭션을 수행할 때 유용합니다.

서명:

readonly firestore: Firestore;

DocumentReference.id

컬렉션 내 문서의 식별자입니다.

서명:

get id(): string;

DocumentReference.parent

이 DocumentReference이(가) 속한 컬렉션입니다.

서명:

get parent(): CollectionReference<AppModelType, DbModelType>;

문서 참조 경로

참조 문서의 경로를 나타내는 문자열입니다 (데이터베이스 루트 기준).

서명:

get path(): string;

DocumentReference.type

이 Firestore 참조의 유형입니다.

서명:

readonly type = "document";

DocumentReference.withConverter()

이 DocumentReference에 커스텀 데이터 변환기를 적용하면 Firestore에서 자체 커스텀 모델 객체를 사용할 수 있습니다. 반환된 DocumentReference 인스턴스로 setDoc(), getDoc() 등을 호출하면 제공된 변환기가 NewDbModelType 유형의 Firestore 데이터와 커스텀 유형 NewAppModelType 간에 변환합니다.

서명:

withConverter<NewAppModelType, NewDbModelType extends DocumentData = DocumentData>(converter: FirestoreDataConverter<NewAppModelType, NewDbModelType>): DocumentReference<NewAppModelType, NewDbModelType>;

매개변수

매개변수	유형	설명
converter	FirestoreDataConverter<NewAppModelType, NewDbModelType>	객체를 Firestore와 Firestore 간에 변환합니다.

반환:

DocumentReference<NewAppModelType, NewDbModelType>

제공된 변환기를 사용하는 DocumentReference

DocumentReference.withConverter()

현재 변환기를 삭제합니다.

서명:

withConverter(converter: null): DocumentReference<DocumentData, DocumentData>;

매개변수

매개변수	유형	설명
converter	null	null는 현재 변환기를 삭제합니다.

반환:

DocumentReference<DocumentData, DocumentData>

변환기를 사용하지 않는 DocumentReference<DocumentData, DocumentData>