DocumentReference class

DocumentReference относится к местоположению документа в базе данных Firestore и может использоваться для записи, чтения или прослушивания этого местоположения. Документ в указанном месте может существовать, а может и не существовать.

Подпись:

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

Характеристики

Свойство Модификаторы Тип Описание
преобразователь FirestoreDataConverter <AppModelType, DbModelType> | нулевой Если предоставлено, FirestoreDataConverter связанный с этим экземпляром.
пожарная лавка Пожарная лавка Экземпляр Firestore , в котором находится документ. Это полезно, например, для выполнения транзакций.
идентификатор нить Идентификатор документа в его коллекции.
родитель КоллекцияСправочник <AppModelType, DbModelType> Коллекция, к которой принадлежит эта DocumentReference .
путь нить Строка, представляющая путь к указанному документу (относительно корня базы данных).
тип (не заявлено) Тип этой ссылки на Firestore.

Методы

Метод Модификаторы Описание
withConverter (конвертер) Применяет пользовательский преобразователь данных к этому DocumentReference , что позволяет вам использовать собственные объекты модели с Firestore. Когда вы вызываете setDoc() , получитьДоку() и т. д. с помощью возвращенного экземпляра DocumentReference предоставленный преобразователь преобразует данные Firestore типа NewDbModelType в ваш пользовательский тип 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";

ДокументСсылка.withConverter()

Применяет пользовательский преобразователь данных к этому DocumentReference , что позволяет вам использовать свои собственные объекты модели с Firestore. Когда вы вызываете setDoc() , получитьДоку() и т. д. с помощью возвращенного экземпляра DocumentReference предоставленный преобразователь преобразует данные Firestore типа NewDbModelType в ваш собственный тип NewAppModelType .

Подпись:

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

Параметры

Параметр Тип Описание
преобразователь FirestoreDataConverter <NewAppModelType, NewDbModelType> Преобразует объекты в Firestore и обратно.

Возврат:

Ссылка на документ <NewAppModelType, NewDbModelType>

DocumentReference , использующий предоставленный преобразователь.

ДокументСсылка.withConverter()

Удаляет преобразователь тока.

Подпись:

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

Параметры

Параметр Тип Описание
преобразователь нулевой null удаляет преобразователь тока.

Возврат:

Ссылка на документ < Данные документа , Данные документа >

DocumentReference<DocumentData, DocumentData> не использующий преобразователь.