DocumentReference class

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

서명:

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

속성

재산	수정자	유형	설명
변환기		FirestoreDataConverter <AppModelType, DbModelType> | 없는	제공된 경우 이 인스턴스와 연결된 FirestoreDataConverter 입니다.
소방서		소방서	문서가 있는 Firestore 인스턴스입니다. 이는 예를 들어 트랜잭션을 수행하는 데 유용합니다.
ID		끈	컬렉션 내의 문서 식별자입니다.
부모의		컬렉션참조 <AppModelType, DbModelType>	이 DocumentReference 속한 컬렉션입니다.
길		끈	참조된 문서의 경로(데이터베이스 루트 기준)를 나타내는 문자열입니다.
유형		(선언되지 않음)	이 Firestore 참조의 유형입니다.

행동 양식

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

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>;

DocumentReference.path

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

서명:

get path(): string;

DocumentReference.type

이 Firestore 참조의 유형입니다.

서명:

readonly type = "document";

DocumentReference.withConverter()

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

서명:

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

매개변수

매개변수	유형	설명
변환기	FirestoreDataConverter <NewAppModelType, NewDbModelType>	객체를 Firestore로 변환하거나 Firestore에서 변환합니다.

보고:

문서참조 <NewAppModelType, NewDbModelType>

제공된 변환기를 사용하는 DocumentReference 입니다.

DocumentReference.withConverter()

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

서명:

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

매개변수

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

보고:

문서참조 < 문서데이터 , 문서데이터 >

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