Query относится к запросу, который вы можете прочитать или прослушать. Вы также можете создавать уточненные объекты Query , добавляя фильтры и упорядочивая их.
Подпись:
export declare class Query<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData>
Конструкторы
| Конструктор | Модификаторы | Описание |
|---|---|---|
| (конструктор)() | Создает новый экземпляр класса Query . |
Характеристики
| Свойство | Модификаторы | Тип | Описание |
|---|---|---|---|
| преобразователь | FirestoreDataConverter <AppModelType, DbModelType> | нулевой | Если предоставлено, FirestoreDataConverter связанный с этим экземпляром. | |
| пожарная лавка | Пожарная лавка | Экземпляр Firestore для базы данных Firestore (полезен для выполнения транзакций и т. д.). | |
| тип | 'запрос' | 'коллекция' | Тип этой ссылки на Firestore. |
Методы
| Метод | Модификаторы | Описание |
|---|---|---|
| withConverter (конвертер) | Удаляет преобразователь тока. | |
| withConverter (конвертер) | Применяет к этому запросу пользовательский преобразователь данных, позволяющий использовать собственные объекты модели с Firestore. Когда вы вызываете getDocs() с возвращенным запросом, предоставленный преобразователь преобразует данные Firestore типа NewDbModelType в ваш пользовательский тип NewAppModelType . |
Запрос.(конструктор)
Создает новый экземпляр класса Query .
Подпись:
protected constructor();
Запрос.конвертер
Если предоставлено, FirestoreDataConverter связанный с этим экземпляром.
Подпись:
readonly converter: FirestoreDataConverter<AppModelType, DbModelType> | null;
Запрос.firestore
Экземпляр Firestore для базы данных Firestore (полезен для выполнения транзакций и т. д.).
Подпись:
readonly firestore: Firestore;
Тип запроса
Тип этой ссылки на Firestore.
Подпись:
readonly type: 'query' | 'collection';
Запрос.withConverter()
Удаляет преобразователь тока.
Подпись:
withConverter(converter: null): Query<DocumentData, DocumentData>;
Параметры
| Параметр | Тип | Описание |
|---|---|---|
| преобразователь | нулевой | null удаляет преобразователь тока. |
Возврат:
Запрос < Данные документа , Данные документа >
Query<DocumentData, DocumentData> , который не использует преобразователь.
Запрос.withConverter()
Применяет к этому запросу пользовательский преобразователь данных, позволяющий использовать собственные объекты модели с Firestore. Когда вы вызываете getDocs() с возвращенным запросом, предоставленный преобразователь преобразует данные Firestore типа NewDbModelType в ваш собственный тип NewAppModelType .
Подпись:
withConverter<NewAppModelType, NewDbModelType extends DocumentData = DocumentData>(converter: FirestoreDataConverter<NewAppModelType, NewDbModelType>): Query<NewAppModelType, NewDbModelType>;
Параметры
| Параметр | Тип | Описание |
|---|---|---|
| преобразователь | FirestoreDataConverter <NewAppModelType, NewDbModelType> | Преобразует объекты в Firestore и обратно. |
Возврат:
Запрос <NewAppModelType, NewDbModelType>
Query , использующий предоставленный преобразователь.