CollectionReference class

CollectionReference 객체는 문서를 추가하고, 문서 참조를 가져오며, 문서를 쿼리 (query() 사용)하는 데 사용할 수 있습니다.

서명:

export declare class CollectionReference<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData> extends Query<AppModelType, DbModelType> 

확장: Query<AppModelType, DBMModelType>

속성

속성	특수키	유형	설명
id		문자열	컬렉션의 식별자입니다.
parent		DocumentReference<DocumentData, DocumentData> | 없음	하위 컬렉션인 경우 포함하는 DocumentReference에 대한 참조입니다. 하위 컬렉션이 아니면 참조는 null입니다.
경로		문자열	참조된 컬렉션의 경로를 나타내는 문자열입니다 (데이터베이스 루트 기준).
type		(선언되지 않음)	이 Firestore 참조의 유형입니다.

메소드

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

CollectionReference.id

컬렉션의 식별자입니다.

서명:

get id(): string;

CollectionReference.parent

하위 컬렉션인 경우 포함하는 DocumentReference에 대한 참조입니다. 하위 컬렉션이 아니면 참조는 null입니다.

서명:

get parent(): DocumentReference<DocumentData, DocumentData> | null;

CollectionReference.path

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

서명:

get path(): string;

CollectionReference.type

이 Firestore 참조의 유형입니다.

서명:

readonly type = "collection";

CollectionReference.withConverter()

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

서명:

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

매개변수

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

반환:

CollectionReference<NewAppModelType, NewDbModelType>

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

CollectionReference.withConverter()

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

서명:

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

매개변수

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

반환:

CollectionReference<DocumentData, DocumentData>

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