Объект CollectionReference можно использовать для добавления документов, получения ссылок на документы и запроса документов (с помощью query()). ).
Подпись:
export declare class CollectionReference<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData> extends Query<AppModelType, DbModelType>
Расширяет: запрос <AppModelType, DbModelType>
Характеристики
| Свойство | Модификаторы | Тип | Описание |
|---|---|---|---|
| идентификатор | нить | Идентификатор коллекции. | |
| родитель | Ссылка на документ < Данные документа , Данные документа > | нулевой | Ссылка на содержащуюся DocumentReference , если это подколлекция. Если это не подколлекция, ссылка равна нулю. | |
| путь | нить | Строка, представляющая путь к указанной коллекции (относительно корня базы данных). | |
| тип | (не заявлено) | Тип этой ссылки на Firestore. |
Методы
| Метод | Модификаторы | Описание |
|---|---|---|
| withConverter (конвертер) | Применяет пользовательский преобразователь данных к этому CollectionReference , что позволяет вам использовать собственные объекты модели с Firestore. Когда вы вызываете addDoc() с возвращенным экземпляром CollectionReference , предоставленный преобразователь преобразует данные Firestore типа NewDbModelType в ваш пользовательский тип NewAppModelType . | |
| withConverter (конвертер) | Удаляет преобразователь тока. |
КоллекцияReference.id
Идентификатор коллекции.
Подпись:
get id(): string;
КоллекцияReference.parent
Ссылка на содержащуюся DocumentReference , если это подколлекция. Если это не подколлекция, ссылка равна нулю.
Подпись:
get parent(): DocumentReference<DocumentData, DocumentData> | null;
CollectionReference.path
Строка, представляющая путь к указанной коллекции (относительно корня базы данных).
Подпись:
get path(): string;
КоллекцияReference.type
Тип этой ссылки на Firestore.
Подпись:
readonly type = "collection";
КоллекцияReference.withConverter()
Применяет пользовательский преобразователь данных к этой CollectionReference , что позволяет вам использовать свои собственные объекты модели с Firestore. Когда вы вызываете addDoc() с возвращенным экземпляром CollectionReference , предоставленный преобразователь преобразует данные Firestore типа NewDbModelType в ваш собственный тип NewAppModelType .
Подпись:
withConverter<NewAppModelType, NewDbModelType extends DocumentData = DocumentData>(converter: FirestoreDataConverter<NewAppModelType, NewDbModelType>): CollectionReference<NewAppModelType, NewDbModelType>;
Параметры
| Параметр | Тип | Описание |
|---|---|---|
| преобразователь | FirestoreDataConverter <NewAppModelType, NewDbModelType> | Преобразует объекты в Firestore и обратно. |
Возврат:
КоллекцияСправочник <NewAppModelType, NewDbModelType>
CollectionReference , использующий предоставленный преобразователь.
КоллекцияReference.withConverter()
Удаляет преобразователь тока.
Подпись:
withConverter(converter: null): CollectionReference<DocumentData, DocumentData>;
Параметры
| Параметр | Тип | Описание |
|---|---|---|
| преобразователь | нулевой | null удаляет преобразователь тока. |
Возврат:
КоллекцияСправочник < Данные документа , Данные документа >
CollectionReference<DocumentData, DocumentData> не использующий преобразователь.