@firebase/firestore

Функции

Функция Описание
функция (приложение, ...)
getFirestore (приложение) Возвращает существующий экземпляр Firestore по умолчанию, связанный с предоставленным FirebaseApp. . Если экземпляра не существует, инициализирует новый экземпляр с настройками по умолчанию.
getFirestore (приложение, идентификатор базы данных) (БЕТА) Возвращает существующий именованный экземпляр Firestore , связанный с предоставленным FirebaseApp. . Если экземпляра не существует, инициализирует новый экземпляр с настройками по умолчанию.
инициализироватьFirestore (приложение, настройки, идентификатор базы данных) Инициализирует новый экземпляр Firestore с предоставленными настройками. Может быть вызван только перед любой другой функцией, включая getFirestore(). . Если пользовательские настройки пусты, эта функция эквивалентна вызову getFirestore(). .
функция(пожарная, ...)
ClearIndexedDbPersistence (хранилище огня) Очищает постоянное хранилище. Сюда входят ожидающие записи и кэшированные документы. Должен вызываться, пока экземпляр Firestore не запущен (после закрытия приложения или при первой инициализации приложения). При запуске эта функция должна вызываться перед другими функциями (кроме InitializeFirestore() или getFirestore()). )). Если экземпляр Firestore все еще работает, обещание будет отклонено с кодом ошибки failed-precondition . Примечание. clearIndexedDbPersistence() в первую очередь предназначена для написания надежных тестов, использующих Cloud Firestore. Он использует эффективный механизм удаления существующих данных, но не пытается безопасно перезаписать или иным образом сделать кэшированные данные невосстановимыми. Для приложений, которые чувствительны к раскрытию кэшированных данных между пользовательскими сеансами, мы настоятельно рекомендуем вообще не включать сохранение.
коллекция (firestore, путь, pathSegments) Получает экземпляр CollectionReference , который ссылается на коллекцию по указанному абсолютному пути.
CollectionGroup(Firestore, CollectionId) Создает и возвращает новый экземпляр Query , включающий все документы в базе данных, содержащиеся в коллекции или подколлекции с заданным collectionId .
ConnectFirestoreEmulator (firestore, хост, порт, параметры) Измените этот экземпляр для связи с эмулятором Cloud Firestore. Примечание. Его необходимо вызвать до того, как этот экземпляр будет использоваться для выполнения каких-либо операций.
отключить сеть (пожарное хранилище) Отключает использование сети для этого экземпляра. Его можно повторно включить с помощью EnableNetwork(). . Пока сеть отключена, любые прослушиватели снимков, вызовы getDoc() или getDocs() будут возвращать результаты из кэша, а любые операции записи будут поставлены в очередь до тех пор, пока сеть не будет восстановлена.
документ (firestore, путь, pathSegments) Получает экземпляр DocumentReference , который ссылается на документ по указанному абсолютному пути.
EnableIndexedDbPersistence (firestore, persistenceSettings) Пытается включить постоянное хранилище, если это возможно. В случае неудачи enableIndexedDbPersistence() отклонит обещание или выдаст исключение. Существует несколько причин, по которым это может привести к сбою, которые можно определить по code ошибки. * Неудачное предварительное условие: приложение уже открыто в другой вкладке браузера. * не реализовано: браузер несовместим с реализацией автономного сохранения. Обратите внимание, что даже после сбоя экземпляр Firestore останется работоспособным, однако сохранение в автономном режиме будет отключено. Примечание. enableIndexedDbPersistence() необходимо вызывать перед любыми другими функциями (кроме InitializeFirestore()). , getFirestore() или ClearIndexedDbPersistence() . Персистентность нельзя использовать в среде Node.js.
EnableMultiTabIndexedDbPersistence (хранилище огня) Пытается включить постоянное хранилище с несколькими вкладками, если это возможно. Если этот параметр включен на всех вкладках, все операции имеют общий доступ к локальному хранилище, включая совместное выполнение запросов и обновление локальных документов с компенсацией задержки во всех подключенных экземплярах. В случае неудачи enableMultiTabIndexedDbPersistence() отклонит обещание или выдаст исключение. Существует несколько причин, по которым это может привести к сбою, которые можно определить по code ошибки. * Неудачное предварительное условие: приложение уже открыто в другой вкладке браузера, а поддержка нескольких вкладок не включена. * не реализовано: браузер несовместим с реализацией автономного сохранения. Обратите внимание, что даже после сбоя экземпляр Firestore останется работоспособным, однако сохранение в автономном режиме будет отключено.
включить сеть (пожарное хранилище) Повторно разрешает использование сети для этого экземпляра Firestore после предварительного вызова метода DisableNetwork(). .
getPersistentCacheIndexManager (хранилище огня) Возвращает диспетчер индексов PersistentCache, используемый данным объектом Firestore . Экземпляр PersistentCacheIndexManager или null , если локальное постоянное хранилище не используется.
loadBundle (firestore, BundleData) Загружает пакет Firestore в локальный кеш.
nameQuery(хранилище огня, имя) Считывает запрос Firestore из локального кеша, идентифицируемого по заданному имени. Именованные запросы упаковываются в пакеты на стороне сервера (вместе с результирующими документами) и загружаются в локальный кеш с помощью loadBundle . Попав в локальный кеш, используйте этот метод для извлечения запроса по имени.
onSnapshotsInSync(хранилище огня, наблюдатель) Подключает прослушиватель для события синхронизации снимков. Событие синхронизации снимков указывает на то, что все прослушиватели, затронутые данным изменением, были активированы, даже если одно изменение, сгенерированное сервером, затрагивает несколько прослушивателей. ПРИМЕЧАНИЕ. Событие синхронизации снимков указывает только на то, что прослушиватели синхронизированы друг с другом, но не имеет отношения к тому, синхронизированы ли эти снимки с сервером. Используйте SnapshotMetadata в отдельных прослушивателях, чтобы определить, взят ли моментальный снимок из кэша или с сервера.
onSnapshotsInSync(firestore, onSync) Подключает прослушиватель для события синхронизации снимков. Событие синхронизации снимков указывает на то, что все прослушиватели, затронутые данным изменением, были активированы, даже если одно изменение, сгенерированное сервером, затрагивает несколько прослушивателей. ПРИМЕЧАНИЕ. Событие синхронизации снимков указывает только на то, что прослушиватели синхронизированы друг с другом, но не имеет отношения к тому, синхронизированы ли эти снимки с сервером. Используйте SnapshotMetadata в отдельных прослушивателях, чтобы определить, взят ли моментальный снимок из кэша или с сервера.
runTransaction (firestore, updateFunction, параметры) Выполняет заданную updateFunction , а затем пытается зафиксировать изменения, примененные в транзакции. Если какой-либо документ, прочитанный в транзакции, изменился, Cloud Firestore повторяет updateFunction . Если после 5 попыток не удалось зафиксировать транзакцию, она завершится неудачей. Максимальное количество операций записи, разрешенное в одной транзакции, составляет 500.
setIndexConfiguration(firestore, конфигурация) (БЕТА) Настраивает индексацию для выполнения локальных запросов. Любая предыдущая конфигурация индекса переопределяется. Promise разрешается после сохранения конфигурации индекса. Сами записи индекса создаются асинхронно. Вы можете продолжать использовать запросы, требующие индексации, даже если индексы еще недоступны. Выполнение запроса автоматически начнет использовать индекс после записи записей индекса. Индексы поддерживаются только с сохранением IndexedDb. Если IndexedDb не включен, любая конфигурация индекса игнорируется.
setIndexConfiguration (firestore, json) (БЕТА) Настраивает индексацию для выполнения локальных запросов. Любая предыдущая конфигурация индекса переопределяется. Promise разрешается после сохранения конфигурации индекса. Сами записи индекса создаются асинхронно. Вы можете продолжать использовать запросы, требующие индексации, даже если индексы еще недоступны. Выполнение запроса автоматически начнется с использованием индекса после записи записей индекса. Индексы поддерживаются только с сохранением IndexedDb. Вызовите enableIndexedDbPersistence() или enableMultiTabIndexedDbPersistence() перед установкой конфигурации индекса. Если IndexedDb не включен, любая конфигурация индекса игнорируется. Этот метод принимает формат JSON, экспортированный через интерфейс командной строки Firebase ( firebase firestore:indexes ). Если формат JSON недействителен, этот метод выдает ошибку.
прекратить (пожарный магазин) Завершает предоставленный экземпляр Firestore . После вызова метода terminate() можно использовать только clearIndexedDbPersistence() . Любая другая функция выдаст FirestoreError . Чтобы перезапустить после завершения, создайте новый экземпляр FirebaseFirestore с помощью getFirestore(). . Завершение не отменяет никакие ожидающие записи, и любые обещания, ожидающие ответа от сервера, не будут разрешены. Если у вас включено сохранение, при следующем запуске этого экземпляра он возобновит отправку этих записей на сервер. Примечание. В обычных обстоятельствах вызов метода terminate() не требуется. Эта функция полезна только в том случае, если вы хотите заставить этот экземпляр освободить все свои ресурсы, или в сочетании с clearIndexedDbPersistence() чтобы гарантировать, что все локальное состояние уничтожается между запусками тестов.
waitForPendingWrites (хранилище огня) Ожидает, пока все ожидающие записи для активного пользователя не будут подтверждены серверной частью. Возвращенное обещание разрешается немедленно, если нет невыполненных операций записи. В противном случае обещание ожидает всех ранее выполненных операций записи (включая записи, выполненные в предыдущем сеансе приложения), но не ожидает операций записи, добавленных после вызова функции. Если вы хотите дождаться дополнительных записей, снова вызовите waitForPendingWrites() . Любые невыполненные обещания waitForPendingWrites() отклоняются во время изменения пользователя.
writeBatch (пожарный магазин) Создает пакет записи, используемый для выполнения нескольких операций записи как одной атомарной операции. Максимальное количество операций записи, разрешенное в одном WriteBatch , составляет 500. В отличие от транзакций, пакеты записи сохраняются в автономном режиме и поэтому предпочтительнее, когда вам не нужно обусловливать запись считанными данными.
функция()
считать() Создайте объект AggregateField, который можно использовать для вычисления количества документов в наборе результатов запроса.
удалитьField() Возвращает контрольный показатель для использования с updateDoc() или setDoc() с {merge: true} чтобы пометить поле для удаления.
идентификатор документа() Возвращает специальный контрольный FieldPath для ссылки на идентификатор документа. Его можно использовать в запросах для сортировки или фильтрации по идентификатору документа.
getFirestore() Возвращает существующий экземпляр Firestore по умолчанию, связанный с FirebaseApp по умолчанию. . Если экземпляра не существует, инициализирует новый экземпляр с настройками по умолчанию.
MemoryEagerGarbageCollector() Создает экземпляр MemoryEagerGarbageCollector . Это также сборщик мусора по умолчанию, если явно не указано иное.
постоянныйMultipleTabManager() Создает экземпляр PersistentMultipleTabManager .
серверTimestamp() Возвращает контрольный показатель, используемый с помощью setDoc() или updateDoc() для включения в записываемые данные временной метки, сгенерированной сервером.
функция (идентификатор базы данных, ...)
getFirestore (идентификатор базы данных) (БЕТА) Возвращает существующий именованный экземпляр Firestore , связанный с FirebaseApp по умолчанию. . Если экземпляра не существует, инициализирует новый экземпляр с настройками по умолчанию.
функция(элементы, ...)
массивRemove (элементы) Возвращает специальное значение, которое можно использовать с setDoc() или которое сообщает серверу удалить данные элементы из любого значения массива, которое уже существует на сервере. Все экземпляры каждого указанного элемента будут удалены из массива. Если изменяемое поле еще не является массивом, оно будет перезаписано пустым массивом.
массивUnion (элементы) Возвращает специальное значение, которое можно использовать с setDoc() или updateDoc() , которое сообщает серверу объединить данные элементы с любым значением массива, которое уже существует на сервере. Каждый указанный элемент, которого еще нет в массиве, будет добавлен в конец. Если изменяемое поле еще не является массивом, оно будет перезаписано массивом, содержащим именно указанные элементы.
функция(поле, ...)
среднее (поле) Создайте объект AggregateField, который можно использовать для вычисления среднего значения указанного поля по диапазону документов в наборе результатов запроса.
сумма (поле) Создайте объект AggregateField, который можно использовать для вычисления суммы указанного поля по диапазону документов в наборе результатов запроса.
функция (путь к полю, ...)
orderBy (fieldPath, DirectionStr) Создает QueryOrderByConstraint , который сортирует результат запроса по указанному полю, при необходимости в порядке убывания, а не по возрастанию. Примечание. Документы, не содержащие указанного поля, не будут присутствовать в результатах запроса.
где (fieldPath, opStr, значение) Создает QueryFieldFilterConstraint , который гарантирует, что документы должны содержать указанное поле и что значение должно удовлетворять предоставленному ограничению отношения.
функция (значения полей, ...)
endAt(значения полей) Создает QueryEndAtConstraint , который изменяет набор результатов, чтобы он заканчивался указанными полями относительно порядка запроса. Порядок значений полей должен соответствовать порядку пунктов запроса.
endBefore (значения полей) Создает QueryEndAtConstraint , который изменяет набор результатов, чтобы он заканчивался перед предоставленными полями относительно порядка запроса. Порядок значений полей должен соответствовать порядку пунктов запроса.
startAfter (значения полей) Создает QueryStartAtConstraint , который изменяет набор результатов, чтобы он начинался после предоставленных полей относительно порядка запроса. Порядок значений полей должен соответствовать порядку пунктов запроса.
startAt(значения полей) Создает QueryStartAtConstraint , который изменяет набор результатов, чтобы он начинался с предоставленных полей относительно порядка запроса. Порядок значений полей должен соответствовать порядку пунктов запроса.
функция (менеджер индексов, ...)
deleteAllPersistentCacheIndexes (indexManager) Удаляет все индексы постоянного кэша. Обратите внимание, что эта функция также удалит индексы, созданные функцией setIndexConfiguration() , которая устарела.
отключитьPersistentCacheIndexAutoCreation (indexManager) Останавливает автоматическое создание индексов постоянного кэша для выполнения локальных запросов. Индексы, созданные с помощью метода enablePersistentCacheIndexAutoCreation() по-прежнему вступают в силу.
EnablePersistentCacheIndexAutoCreation (indexManager) Позволяет SDK автоматически создавать индексы постоянного кэша для выполнения локальных запросов, если SDK считает, что индексы кэша могут помочь повысить производительность. Эта функция отключена по умолчанию.
функция (слева, ...)
агрегатFieldEqual(слева, справа) Сравнивает два AggregateField ` экземпляры для равенства.
агрегатQuerySnapshotEqual(слева, справа) Сравнивает два экземпляра AggregateQuerySnapshot на предмет равенства. Два экземпляра AggregateQuerySnapshot считаются «равными», если у них есть базовые запросы, которые сравнивают равные и одинаковые данные.
queryEqual (слева, справа) Возвращает true, если предоставленные запросы указывают на одну и ту же коллекцию и применяют одни и те же ограничения.
refEqual(слева, справа) Возвращает true, если предоставленные ссылки равны.
снимокEqual(слева, справа) Возвращает true, если предоставленные снимки равны.
функция(предел, ...)
лимит (лимит) Создает QueryLimitConstraint , который возвращает только первые соответствующие документы.
limitToLast(ограничение) Создает QueryLimitConstraint , который возвращает только последние соответствующие документы. Вы должны указать хотя бы одно предложение orderBy для запросов limitToLast , иначе во время выполнения будет выдано исключение.
функция (logLevel, ...)
setLogLevel (уровень журнала) Устанавливает уровень детализации журналов Cloud Firestore (отладка, ошибка или тихий режим).
функция (п, ...)
приращение (n) Возвращает специальное значение, которое можно использовать с setDoc() или updateDoc() , которое сообщает серверу увеличить текущее значение поля на заданное значение. Если операнд или текущее значение поля используют точность с плавающей запятой, вся арифметика соответствует семантике IEEE 754. Если оба значения являются целыми числами, значения за пределами безопасного диапазона чисел JavaScript ( Number.MIN_SAFE_INTEGER до Number.MAX_SAFE_INTEGER ) также подвержены потере точности. Более того, после обработки бэкэндом Firestore все целочисленные операции ограничиваются диапазоном от -2^63 до 2^63-1. Если текущее значение поля не имеет типа number или если поле еще не существует, преобразование присваивает полю заданное значение.
функция (запрос, ...)
getAggregateFromServer (запрос, агрегатная спецификация) Вычисляет указанные агрегаты по документам в наборе результатов данного запроса без фактической загрузки документов. Использование этой функции для выполнения агрегирования эффективно, поскольку загружаются только окончательные значения агрегирования, а не данные документов. Эта функция может выполнять агрегирование документов в тех случаях, когда набор результатов слишком велик для загрузки целиком (тысячи документов). Результат, полученный с сервера, представляется неизмененным, без учета какого-либо локального состояния. То есть документы в локальном кеше не учитываются, равно как и локальные модификации, еще не синхронизированные с сервером. Ранее загруженные результаты, если таковые имеются, не используются. Каждый вызов этой функции обязательно включает в себя обращение к серверу.
getCountFromServer (запрос) Вычисляет количество документов в наборе результатов данного запроса без фактической загрузки документов. Использование этой функции для подсчета документов эффективно, поскольку загружаются только окончательные результаты подсчета, а не данные документов. Эта функция может подсчитывать документы в тех случаях, когда набор результатов слишком велик для загрузки целиком (тысячи документов). Результат, полученный с сервера, представляется неизмененным, без учета какого-либо локального состояния. То есть документы в локальном кеше не учитываются, равно как и локальные модификации, еще не синхронизированные с сервером. Ранее загруженные результаты, если таковые имеются, не используются. Каждый вызов этой функции обязательно включает в себя обращение к серверу.
получитьДокументы (запрос) Выполняет запрос и возвращает результаты в виде QuerySnapshot . Примечание. getDocs() пытается предоставить актуальные данные, когда это возможно, ожидая данных с сервера, но он может вернуть кэшированные данные или потерпеть неудачу, если вы находитесь в автономном режиме и сервер недоступен. Чтобы указать это поведение, вызовите getDocsFromCache() или getDocsFromServer(). .
getDocsFromCache (запрос) Выполняет запрос и возвращает результаты в виде QuerySnapshot из кэша. Возвращает пустой набор результатов, если в настоящий момент не кэшируются документы, соответствующие запросу.
getDocsFromServer (запрос) Выполняет запрос и возвращает результаты в виде QuerySnapshot с сервера. Возвращает ошибку, если сеть недоступна.
onSnapshot (запрос, наблюдатель) Подключает прослушиватель событий QuerySnapshot . Вы можете либо передать отдельные обратные вызовы onNext и onError , либо передать один объект-наблюдатель с обратными вызовами next и error . Прослушиватель можно отменить, вызвав функцию, которая возвращается при вызове onSnapshot . ПРИМЕЧАНИЕ. Хотя обратный вызов onCompletion может быть предоставлен, он никогда не будет вызываться, поскольку поток моментальных снимков бесконечен.
onSnapshot (запрос, параметры, наблюдатель) Подключает прослушиватель событий QuerySnapshot . Вы можете либо передать отдельные обратные вызовы onNext и onError , либо передать один объект-наблюдатель с обратными вызовами next и error . Прослушиватель можно отменить, вызвав функцию, которая возвращается при вызове onSnapshot . ПРИМЕЧАНИЕ. Хотя обратный вызов onCompletion может быть предоставлен, он никогда не будет вызываться, поскольку поток моментальных снимков бесконечен.
onSnapshot (запрос, onNext, onError, onCompletion) Подключает прослушиватель событий QuerySnapshot . Вы можете либо передать отдельные обратные вызовы onNext и onError , либо передать один объект-наблюдатель с обратными вызовами next и error . Прослушиватель можно отменить, вызвав функцию, которая возвращается при вызове onSnapshot . ПРИМЕЧАНИЕ. Хотя обратный вызов onCompletion может быть предоставлен, он никогда не будет вызываться, поскольку поток моментальных снимков бесконечен.
onSnapshot (запрос, параметры, onNext, onError, onCompletion) Подключает прослушиватель событий QuerySnapshot . Вы можете либо передать отдельные обратные вызовы onNext и onError , либо передать один объект-наблюдатель с обратными вызовами next и error . Прослушиватель можно отменить, вызвав функцию, которая возвращается при вызове onSnapshot . ПРИМЕЧАНИЕ. Хотя обратный вызов onCompletion может быть предоставлен, он никогда не будет вызываться, поскольку поток моментальных снимков бесконечен.
запрос (запрос, составной фильтр, queryConstraints) Создает новый неизменяемый экземпляр Query , который расширяется и включает дополнительные ограничения запроса.
запрос (запрос, queryConstraints) Создает новый неизменяемый экземпляр Query , который расширяется и включает дополнительные ограничения запроса.
функция (queryConstraints, ...)
и (ограничения запроса) Создает новый QueryCompositeFilterConstraint , который является сочетанием заданных ограничений фильтра. Фильтр конъюнкции включает документ, если он удовлетворяет всем заданным фильтрам.
или(queryConstraints) Создает новый QueryCompositeFilterConstraint , который является дизъюнкцией заданных ограничений фильтра. Фильтр дизъюнкции включает документ, если он удовлетворяет любому из заданных фильтров.
функция (ссылка, ...)
addDoc(ссылка, данные) Добавьте новый документ в указанную CollectionReference с заданными данными, автоматически присвоив ему идентификатор документа.
коллекция (ссылка, путь, pathSegments) Получает экземпляр CollectionReference , который ссылается на reference вложенную коллекцию по указанному относительному пути.
коллекция (ссылка, путь, pathSegments) Получает экземпляр CollectionReference , который ссылается на reference вложенную коллекцию по указанному относительному пути.
удалитьDoc (ссылка) Удаляет документ, на который ссылается указанный DocumentReference .
документ (ссылка, путь, сегменты пути) Получает экземпляр DocumentReference , который ссылается на документ в reference по указанному относительному пути. Если путь не указан, для возвращаемого DocumentReference будет использоваться автоматически сгенерированный уникальный идентификатор.
документ (ссылка, путь, сегменты пути) Получает экземпляр DocumentReference , который ссылается на документ в reference по указанному относительному пути.
getDoc (ссылка) Читает документ, на который ссылается этот DocumentReference . Примечание. getDoc() пытается предоставить актуальные данные, когда это возможно, ожидая данных с сервера, но он может вернуть кэшированные данные или потерпеть неудачу, если вы находитесь в автономном режиме и сервер недоступен. Чтобы указать это поведение, вызовите getDocFromCache() или getDocFromServer(). .
getDocFromCache (ссылка) Считывает документ, на который ссылается эта DocumentReference , из кэша. Возвращает ошибку, если документ в данный момент не кэширован.
getDocFromServer (ссылка) Считывает документ, на который ссылается эта DocumentReference , с сервера. Возвращает ошибку, если сеть недоступна.
onSnapshot (ссылка, наблюдатель) Подключает прослушиватель событий DocumentSnapshot . Вы можете либо передать отдельные обратные вызовы onNext и onError , либо передать один объект-наблюдатель с обратными вызовами next и error . ПРИМЕЧАНИЕ. Хотя обратный вызов onCompletion может быть предоставлен, он никогда не будет вызываться, поскольку поток моментальных снимков бесконечен.
onSnapshot (ссылка, параметры, наблюдатель) Подключает прослушиватель событий DocumentSnapshot . Вы можете либо передать отдельные обратные вызовы onNext и onError , либо передать один объект-наблюдатель с обратными вызовами next и error . ПРИМЕЧАНИЕ. Хотя обратный вызов onCompletion может быть предоставлен, он никогда не будет вызываться, поскольку поток моментальных снимков бесконечен.
onSnapshot (ссылка, onNext, onError, onCompletion) Подключает прослушиватель событий DocumentSnapshot . Вы можете либо передать отдельные обратные вызовы onNext и onError , либо передать один объект-наблюдатель с обратными вызовами next и error . ПРИМЕЧАНИЕ. Хотя обратный вызов onCompletion может быть предоставлен, он никогда не будет вызываться, поскольку поток моментальных снимков бесконечен.
onSnapshot (ссылка, параметры, onNext, onError, onCompletion) Подключает прослушиватель событий DocumentSnapshot . Вы можете либо передать отдельные обратные вызовы onNext и onError , либо передать один объект-наблюдатель с обратными вызовами next и error . ПРИМЕЧАНИЕ. Хотя обратный вызов onCompletion может быть предоставлен, он никогда не будет вызываться, поскольку поток моментальных снимков бесконечен.
setDoc (ссылка, данные) Записывает документ, на который ссылается этот DocumentReference . Если документ еще не существует, он будет создан.
setDoc(ссылка, данные, параметры) Записывает документ, на который ссылается указанный DocumentReference . Если документ еще не существует, он будет создан. Если вы предоставляете merge или mergeFields , предоставленные данные можно объединить с существующим документом.
updateDoc(ссылка, данные) Обновляет поля в документе, на который ссылается указанный DocumentReference . Обновление завершится неудачно, если оно будет применено к несуществующему документу.
updateDoc (ссылка, поле, значение, moreFieldsAndValues) Обновляет поля в документе, на который ссылается указанная DocumentReference Обновление завершится неудачно, если оно будет применено к несуществующему документу. Вложенные поля можно обновлять, предоставляя строки путей к полям, разделенные точками, или предоставляя объекты FieldPath .
функция (настройки, ...)
MemoryLocalCache (настройки) Создает экземпляр MemoryLocalCache . Для экземпляра можно установить FirestoreSettings.cache чтобы сообщить SDK, какой уровень кэша использовать.
MemoryLruGarbageCollector (настройки) Создает экземпляр MemoryLruGarbageCollector . Целевой размер можно указать как часть параметра настройки. Сборщик начнет удалять документы, как только размер кэша превысит заданный размер. Размер кэша по умолчанию составляет 40 МБ (40 * 1024 * 1024 байт).
persistLocalCache (настройки) Создает экземпляр PersistentLocalCache . Для экземпляра можно установить FirestoreSettings.cache чтобы сообщить SDK, какой уровень кэша использовать. Постоянный кеш нельзя использовать в среде Node.js.
persistSingleTabManager (настройки) Создает экземпляр PersistentSingleTabManager .
функция (снимок, ...)
endAt(снимок) Создает QueryEndAtConstraint , который изменяет набор результатов так, чтобы он заканчивался на предоставленном документе (включительно). Конечная позиция зависит от порядка запроса. Документ должен содержать все поля, указанные в orderBy запроса.
endBefore (снимок) Создает QueryEndAtConstraint , который изменяет набор результатов, чтобы он заканчивался до предоставленного документа (эксклюзивный). Конечная позиция зависит от порядка запроса. Документ должен содержать все поля, указанные в orderBy запроса.
startAfter(снимок) Создает QueryStartAtConstraint , который изменяет набор результатов, чтобы он начинался после предоставленного документа (эксклюзивно). Начальная позиция зависит от порядка запроса. Документ должен содержать все поля, указанные в orderBy запроса.
startAt(снимок) Создает QueryStartAtConstraint , который изменяет набор результатов, чтобы он начинался с предоставленного документа (включительно). Начальная позиция зависит от порядка запроса. Документ должен содержать все поля, указанные в orderBy этого запроса.
функция(значения, ...)
вектор(значения) Создает новое VectorValue , созданное на основе копии заданного массива чисел.

Классы

Сорт Описание
Агрегатефилд Представляет агрегацию, которую может выполнить Firestore.
Снимок агрегатного запроса Результаты выполнения запроса агрегации.
Байты Неизменяемый объект, представляющий массив байтов.
КоллекцияСправочник Объект CollectionReference можно использовать для добавления документов, получения ссылок на документы и запроса документов (с помощью query()). ).
Ссылка на документ DocumentReference относится к местоположению документа в базе данных Firestore и может использоваться для записи, чтения или прослушивания этого местоположения. Документ в указанном месте может существовать, а может и не существовать.
Снимок документа DocumentSnapshot содержит данные, считанные из документа в вашей базе данных Firestore. Данные можно извлечь с помощью .data() или .get(<field>) для получения определенного поля. Для DocumentSnapshot , указывающего на несуществующий документ, любой доступ к данным вернет «неопределенное». Вы можете использовать метод exists() для явной проверки существования документа.
ФилдПат FieldPath относится к полю в документе. Путь может состоять из одного имени поля (ссылающегося на поле верхнего уровня в документе) или списка имен полей (ссылающегося на вложенное поле в документе). Создайте FieldPath , указав имена полей. Если указано более одного имени поля, путь будет указывать на вложенное поле в документе.
ПолеЗначение Значения Sentinel, которые можно использовать при записи полей документа с помощью set() или update() .
Пожарная лавка Интерфейс сервиса Cloud Firestore. Не вызывайте этот конструктор напрямую. Вместо этого используйте getFirestore() .
FirestoreError Ошибка, возвращаемая операцией Firestore.
ГеоПойнт Неизменяемый объект, представляющий географическое местоположение в Firestore. Местоположение представлено в виде пары широты и долготы. Значения широты находятся в диапазоне [-90, 90]. Значения долготы находятся в диапазоне [-180, 180].
LoadBundleTask Представляет задачу загрузки пакета Firestore. Он отображает ход загрузки пакета, а также события завершения задач и ошибок. API совместим с Promise<LoadBundleTaskProgress> .
ПерсистентКэшИндексМенеджер PersistentCacheIndexManager для настройки индексов постоянного кэша, используемых для выполнения локальных запросов. Чтобы использовать, вызовите getPersistentCacheIndexManager() чтобы получить экземпляр.
Запрос Query относится к запросу, который вы можете прочитать или прослушать. Вы также можете создавать уточненные объекты Query , добавляя фильтры и упорядочивая их.
Ограничение QueryCompositeFilterConstraint QueryCompositeFilterConstraint используется для сужения набора документов, возвращаемых запросом Firestore, путем выполнения логического ИЛИ или И для нескольких QueryFieldFilterConstraint . s или QueryCompositeFilterConstraint с. QueryCompositeFilterConstraint создаются путем вызова or() или and() и затем могут быть переданы в query() для создания нового экземпляра запроса, который также содержит QueryCompositeFilterConstraint .
Ограничение запроса QueryConstraint используется для сужения набора документов, возвращаемых запросом Firestore. QueryConstraint создаются путем вызоваwhere () , заказатьПо() , начатьВ() , стартПосле() , КонецПеред() , КонецАт() , лимит() , limitToLast() и затем может быть передан в query() для создания нового экземпляра запроса, который также содержит этот QueryConstraint .
Снимок документа запроса QueryDocumentSnapshot содержит данные, считанные из документа в вашей базе данных Firestore как часть запроса. Документ гарантированно существует, и его данные можно извлечь с помощью .data() или .get(<field>) для получения определенного поля. QueryDocumentSnapshot предлагает ту же поверхность API, что и DocumentSnapshot . Поскольку результаты запроса содержат только существующие документы, свойство exists всегда будет иметь значение true, а data() никогда не вернет значение «неопределено».
QueryEndAtConstraint QueryEndAtConstraint используется для исключения документов из конца набора результатов, возвращаемого запросом Firestore. QueryEndAtConstraint создаются путем вызова endAt() или endBefore() и затем могут быть переданы в query() для создания нового экземпляра запроса, который также содержит этот QueryEndAtConstraint .
Ограничение QueryFieldFilterConstraint QueryFieldFilterConstraint используется для сужения набора документов, возвращаемых запросом Firestore, путем фильтрации по одному или нескольким полям документа. QueryFieldFilterConstraint создаются путем вызоваwhere () и затем могут быть переданы в query() для создания нового экземпляра запроса, который также содержит этот QueryFieldFilterConstraint .
Ограничение QueryLimitConstraint QueryLimitConstraint используется для ограничения количества документов, возвращаемых запросом Firestore. QueryLimitConstraint создаются путем вызова limit() или limitToLast() и затем могут быть переданы в query() для создания нового экземпляра запроса, который также содержит этот QueryLimitConstraint .
QueryOrderByConstraint QueryOrderByConstraint используется для сортировки набора документов, возвращаемых запросом Firestore. QueryOrderByConstraint создаются путем вызова orderBy() и затем могут быть переданы в query() для создания нового экземпляра запроса, который также содержит этот QueryOrderByConstraint . Примечание. Документы, не содержащие поле orderBy, не будут присутствовать в результатах запроса.
Снимок запроса QuerySnapshot содержит ноль или более объектов DocumentSnapshot , представляющих результаты запроса. Доступ к документам можно получить как массив через свойство docs или перечислить с помощью метода forEach . Количество документов может быть определена с помощью empty и size .
QueryStartatConstraint QueryStartAtConstraint используется для исключения документов с начала результата, возвращаемого запросом Firestore. QueryStartAtConstraint S создается путем вызова startAt () или startafter () , а затем может быть передано в Query () для создания нового экземпляра запроса, который также содержит этот QueryStartAtConstraint .
Snapshotmetadata Метаданные о моментальном снимке, описывающем состояние снимка.
Временная метка Timestamp представляет собой момент времени, независимо от любого часового пояса или календаря, представленной как секунды и доли секунд при разрешении наносекунды в эпоху UTC. Он кодируется с использованием пролепового григорианского календаря, который расширяет григорианский календарь назад до первого года. Это кодируется, предполагая, что все минуты длится 60 секунд, т.е. прыжковые секунды «размазываются», так что для интерпретации не требуется вторая таблица. Диапазон от 0001-01-01t00: 00: 00Z до 9999-12-31T23: 59: 59.999999999Z. Для примеров и дополнительных спецификаций см . .
Сделка Ссылка на транзакцию. Объект Transaction , переданный в updateFunction транзакции, предоставляет методы для чтения и записи данных в контексте транзакции. См. RunTransaction () .
VectorValue Представляет векторный тип в документах Firestore. Создайте экземпляр с. VectorValue
Writebatch Партия записи, используемая для выполнения нескольких записей в виде единичной атомной единицы. Объект WriteBatch может быть получен по вызову wrisesbatch () . Он предоставляет методы для добавления записей в партию записи. Ни одно из записей не будет совершено (или видно локально) до тех пор, пока не будет вызван writebatch.commit () .

Интерфейсы

Интерфейс Описание
Агрегаты Определяет набор агрегаций и их псевдонимов.
Изменение документа DocumentChange представляет собой изменение документов, соответствующих запросу. Он содержит затронутый документ и тип изменений, которые произошли.
DocumentData Данные документа (для использования с setDoc () ) состоит из полей, отображаемых по значениям.
Экспериментальонгполлингопции Параметры, которые настраивают лежащий в основе сетевого транспорта SDK (WebChannel), когда используется длинное заполнение. Примечание. Этот интерфейс является «экспериментальным» и подвергается изменениям. См. FirestoreSettings.experimentalAutoDetectLongPolling , FirestoreSettings.experimentalForceLongPolling и FirestoreSettings.experimentalLongPollingOptions .
Firestoredataconverter Конвертер, используемый с помощью withConverter() для преобразования пользовательских объектов типа AppModelType в данные Firestore типа DbModelType . Использование преобразователя позволяет указать аргументы общего типа при хранении и извлечении объектов из Firestore. В этом контексте «AppModel» - это класс, который используется в приложении для упаковки связанной информации и функциональности. Такой класс, например, может обладать свойствами со сложными, вложенными типами данных, свойствами, используемыми для меморизации, свойствами типов, не поддерживаемых Firestore (например, symbol и bigint ), и вспомогательные функции, которые выполняют составные операции. Такие классы не подходят и/или возможны для хранения в базе данных Firestore. Вместо этого случаи таких классов должны быть преобразованы в «простые старые объекты Javascript» (POJOS) с исключительно примитивными свойствами, потенциально вложенными внутри других POJO или массивов POJO. В этом контексте этот тип называется «DBModel» и будет объектом, подходящим для упорства в Firestore. Для удобства, приложения могут реализовать FirestoreDataConverter и зарегистрировать конвертер с помощью объектов Firestore, таких как DocumentReference или Query , для автоматического преобразования AppModel в DbModel при хранении в Firestore и конвертировании DbModel в AppModel при получении из Firestore.
FirestoreSettings Определяет пользовательские конфигурации для вашего экземпляра Cloud Firestore. Вы должны установить их, прежде чем вызовать какие -либо другие методы.
Индекс (Бета) Определение SDK индекса Firestore.
Индексконфигурация (Бета) Список индексов Firestore для ускорения выполнения локального запроса. См. Формат JSON для описания формата определения индекса.
Indexfield (Бета) Один элемент поля в конфигурации индекса.
LoadBundleTaskProgress Представляет обновление прогресса или окончательное состояние от загрузки пучков.
MemoryCacheSettings Объект настроек для настройки экземпляра MemoryLocalCache .
MemoryeAgergargageCollector Сборщик мусора удаляет документы, если они не являются частью каких-либо активных запросов и к ним не привязаны локальные мутации. Этот сборщик пытается обеспечить минимальное использование памяти SDK, рискуя, что документы не будут кэшироваться для автономных запросов или для прямых запросов к кэшу. Используйте фабричную функцию, чтобы создать экземпляр этого сборщика.
MemoryLocalCache Обеспечивает кеш в памяти SDK. Это кэш по умолчанию, если только явно не настроен иначе. Для использования создайте экземпляр, используя функцию заводской, затем установите экземпляры на FirestoreSettings.cache и вызовите initializeFirestore , используя объект «Настройки».
MemorylrugarbageCollector Сборщик мусора удаляет наименее используемые документы в нескольких партиях. Этот коллектор настроен с целевым размером и будет выполнять коллекцию только тогда, когда кэшированные документы превышают целевой размер. Он позволяет избежать запроса бэкэнда, повторяющегося для того же запроса или документа, рискуя иметь больший след памяти. Используйте заводскую функцию, чтобы создать экземпляр этого коллекционера.
Настойчивости Настройки, которые могут быть переданы, чтобы enableIndexedDbPersistence() для настройки стойкости Firestore. Постоянство не может быть использована в среде Node.js.
PersistentCacheSettings Объект настроек для настройки экземпляра PersistentLocalCache . Постоянный кеш не может быть использован в среде Node.js.
PersistentLocalCache Обеспечивает постоянный кеш, поддерживаемый IndexedDB для SDK. Для использования создайте экземпляр, используя функцию заводской, затем установите экземпляры на FirestoreSettings.cache и вызовите initializeFirestore , используя объект «Настройки».
PersistentMultipleTabManager Диспетчер вкладок, поддерживающий несколько вкладок. SDK будет синхронизировать запросы и мутации, выполняемые на всех вкладках, используя SDK.
Persistentsingletabmanager Диспетчер вкладок, поддерживающий только одну вкладку, не будет выполнена синхронизация на вкладках.
Persistentsletletabmanagersettings Введите для настройки экземпляра PersistentSingleTabManager .
SnapshotListenoptions Объект параметров, который можно передавать в onsnapshot () и querysnapshot.docchanges (), чтобы контролировать, какие типы изменений включают в набор результатов.
Снимки Параметры, которые настраивают, как данные получены из DocumentSnapshot (например, желаемое поведение для временных метров сервера, которые еще не были установлены на их конечное значение).
Transactionoptions Параметры для настройки поведения транзакций.
Отписаться Функция, возвращаемая onSnapshot() , которая удаляет слушателя при призыве.

Переменные

Переменная Описание
Cache_size_unlimited Постоянный, используемый для указания сборника мусора LRU, должна быть отключена. Установите это значение в качестве cacheSizeBytes в настройках, передаваемых в экземпляр Firestore .

Введите псевдонимы

Введите псевдоним Описание
Addprefixtokeys Возвращает новую карту, где каждая клавиша префикс установлен с внешним ключом, добавленным в точку.
Совокупныйфилдтип Союз всех типов AggregateField , которые поддерживаются Firestore.
Агрегаты Тип, ключи которых взяты из AggregateSpec , и чьи значения являются результатом агрегации, выполняемой соответствующим AggregateField из входного AggregateSpec .
Агрегаттип Тип союза, представляющий совокупный тип, который будет выполнен.
Childupdatefields Помощник для расчета вложенных полей для данного типа T1. Это необходимо для распространения типов союзов, таких как undefined | {...} (случается для дополнительных реквизитов) или {a: A} | {b: B} . В этом варианте использования V используется для распределения типов объединений T[K] в Record , поскольку T[K] оценивается как выражение и не распределяется. См
DocumentChangeType Тип DocumentChange может быть «добавлен», «удален» или «модифицирован».
FirestoreErrorCode Набор кодов статуса Firestore. Коды одинаковы на тех, которые выявляются GRPC здесь: https://github.com/grpc/grpc/blob/master/doc/statuscodes.md Возможные значения: - «Отмена»: операция была отменена (обычно вызывающим абонент). - «Неизвестно»: неизвестная ошибка или ошибка из другого домена ошибки. - 'Invalid-Argument': клиент указал неверный аргумент. Обратите внимание, что это отличается от «неудачного назначения». «Недостаточный аргумент» указывает на аргументы, которые являются проблематичными независимо от состояния системы (например, неверное имя поля). - «Срок срока»: срок действия срока истек до завершения операции. Для операций, которые изменяют состояние системы, эта ошибка может быть возвращена, даже если операция успешно завершилась. Например, успешный ответ с сервера мог быть отложено достаточно долго, чтобы срок действия истекала. - «Неудачный»: какой-то запрошенный документ не был найден. - «Уже существует»: какой-то документ, который мы пытались создать, уже существует. - «Разрушение разрешения»: у вызывающего абонента нет разрешения на выполнение указанной операции. -«Ресурс-эксплуатированный»: какой-то ресурс был исчерпан, возможно, квота для каждого пользователя, или, возможно, вся файловая система вышла из космоса. - «Неудачное назначение»: операция была отклонена, потому что система не находится в состоянии, необходимого для выполнения операции. - «Прерванная»: операция была прервана, как правило, из-за вопроса о параллелизме, такой как транзакции, прервания и т. Д. - «Неограниченное»: операция не реализована или не поддерживается/включена. - «Внутренние»: внутренние ошибки. Означает, что некоторые инварианты, ожидаемые базовой системой, были нарушены. Если вы видите одну из этих ошибок, что -то очень сломано. - «недоступен»: в настоящее время услуга недоступна. Это, скорее всего, переходное состояние и может быть исправлено путем повторения с отбором. - «Утолп данных»: невозможно потери или коррупция данных. - «Неавтотифицированный»: запрос не имеет действительных учетных данных аутентификации для операции.
FirestoreLocalCache Тип союза от всех поддерживаемых слоя кэша SDK.
Слушание Опишите источник, который прослушивает запрос. Установите, чтобы default прослушать как кэш, так и изменения сервера. Установите cache для прослушивания изменений только в кэше.
MEARYGARBAGGOLLECTOR Тип союза от всех вспомогательных коллекционеров мусора для локального кеша памяти.
Вложенные Для каждого поля (например, «Бар») найдите все вложенные ключи (например, { 'bar.baz': t1, 'bar.qux': t2 } ). Пересечь их вместе, чтобы сделать одну карту, содержащую все возможные ключи, которые отмечены как необязательные
Порядок работы Направление пункта OrderBy () указывается как «DESC» или «ASC» (нисходящее или восходящее).
PartialwithfieldValue Аналогично Partial<T> TypeScript, но позволяет пропустить вложенные поля, а в качестве значений свойств вкладывает вложенные значения.
Persistenttabmanager Союз всех доступных менеджеров вкладок.
Примитивный Примитивные типы.
QueryConstraintType Описывает различные ограничения запроса, доступные в этом SDK.
QueryfilterConstraint QueryFilterConstraint - это помощник, который представляет QueryfieldFilterConstraint и QueryCompositeFilterConstraint .
QueryNonFilterConstraint QueryNonFilterConstraint - это вспомогательный тип союза, который представляет QueryConstraints, которые используются для сужения или упорядочения набора документов, но которые явно не фильтруют в поле документа. QueryNonFilterConstraint S создается путем вызова OrderBy () , startat () , startaFter () , endfefore () , endat () , Limit () или Limittolast () , а затем может быть передано в Query () для создания нового экземпляра запроса, который также содержит QueryConstraint .
Setoptions Объект параметров, который настраивает поведение setDoc () и звонки. Эти вызовы могут быть настроены для выполнения гранулированных слияний вместо того, чтобы полностью перезаписать целевые документы, предоставляя SetOptions с merge: true .
Таскстате Представляет состояние задач загрузки пучка. Как «ошибка», так и «успех» - это состояние тонущего: задача будет прерван или завершена, и после того, как они сообщают больше, не будет обновлений.
UnionTointersection Учитывает тип союза U = T1 | T2 | ... , возвращает пересекаемый тип (T1 & T2 & ...) . Использует распределительные условные типы и вывод от условных типов. Это работает, потому что несколько кандидатов на одну и ту же переменную типа в противоположных положениях заставляют вывод типа пересечения. https://www.typescriptlang.org/docs/handbook/advanced-types.html#type-inference-in-conditional-types https://stackoverflow.com/questions/50374908/transform-inion-type-to-intersection -тип
Обновляется Обновление данных (для использования с помощью updateC () ), который состоит из полевых путей (например, «foo» или «foo.baz»), отображаемых с значениями. Поля, которые содержат точки, ссылаются на вложенные поля в документе. Field Values ​​может быть передано в качестве значений свойств.
Гдефильтер Условия фильтра в пункте where () указаны с использованием строк «& lt; ',' & lt; = ',' == ','! , 'in', 'Array-Contains-Any' и «Not-in».
Сфилдвейл Позволяет проходить в качестве значения свойства в качестве значения свойства при сохранении безопасности типа.

функция (приложение, ...)

GetFirestore (приложение)

Возвращает существующий экземпляр Firestore по умолчанию, который связан с предоставленным Firebaseapp . Если экземпляра не существует, инициализирует новый экземпляр с настройками по умолчанию.

Подпись:

export declare function getFirestore(app: FirebaseApp): Firestore;

Параметры

Параметр Тип Описание
приложение FirebaseApp Экземпляр Firebaseapp , с которым связан возвращенный экземпляр Firestore .

Возврат:

Пожарная лавка

Экземпляр Firestore по умолчанию предоставленного приложения.

GetFirestore (приложение, база данных)

Этот API предоставляется в качестве предварительного просмотра для разработчиков и может измениться на основе отзывов, которые мы получаем. Не используйте этот API в производственной среде.

Возвращает существующий названный экземпляр Firestore , который связан с предоставленным Firebaseapp . Если экземпляра не существует, инициализирует новый экземпляр с настройками по умолчанию.

Подпись:

export declare function getFirestore(app: FirebaseApp, databaseId: string): Firestore;

Параметры

Параметр Тип Описание
приложение FirebaseApp Экземпляр Firebaseapp , с которым связан возвращенный экземпляр Firestore .
база данных нить Имя базы данных.

Возврат:

Пожарная лавка

Названный экземпляр Firestore предоставленного приложения.

initiazizefirestore (приложение, настройки, база данных)

Инициализирует новый экземпляр Firestore с предоставленными настройками. Может быть вызван только перед любой другой функцией, включая getFirestore () . Если пользовательские настройки пусты, эта функция эквивалентна вызову getFirestore () .

Подпись:

export declare function initializeFirestore(app: FirebaseApp, settings: FirestoreSettings, databaseId?: string): Firestore;

Параметры

Параметр Тип Описание
приложение FirebaseApp Firebaseapp, с которым будет связан экземпляр Firestore .
настройки FirestoreSettings Настройки объекта для настройки экземпляра Firestore .
база данных нить Имя базы данных.

Возврат:

Пожарная лавка

Недавно инициализированный экземпляр Firestore .

функция (Firestore, ...)

ClearIndExedDbperSistence (Firestore)

Очищает постоянное хранилище. Это включает в себя ожидающие записи и кэшированные документы.

Должен быть вызван, пока экземпляр Firestore не запускается (после прекращения приложения или когда приложение впервые инициализировано). При запуске эта функция должна быть вызвана перед другими функциями (кроме инициализациифирстор () или getFirestore () )). Если экземпляр Firestore все еще работает, обещание будет отклонено с кодом ошибки failed-precondition .

Подпись:

export declare function clearIndexedDbPersistence(firestore: Firestore): Promise<void>;

Параметры

Параметр Тип Описание
Firestore Пожарная лавка Экземпляр Firestore , чтобы очистить настойчивость для.

Возврат:

Обещание<void>

Promise , которое разрешено, когда постоянное хранилище очищается. В противном случае обещание отклоняется с ошибкой.

Коллекция (Firestore, Path, Pathsegments)

Получает экземпляр CollectionReference , который относится к коллекции на указанном абсолютном пути.

Подпись:

export declare function collection(firestore: Firestore, path: string, ...pathSegments: string[]): CollectionReference<DocumentData, DocumentData>;

Параметры

Параметр Тип Описание
Firestore Пожарная лавка Ссылка на экземпляр корня Firestore .
путь нить Снизительный путь к коллекции.
пути нить[] Дополнительные сегменты пути для применения относительно первого аргумента.

Возврат:

CollectionReference < DocumentData , DocumentData >

Экземпляр CollectionReference .

Исключения

Если последний путь имеет равномерное количество сегментов и не указывает на коллекцию.

CollectionGroup (Firestore, CollectionId)

Создает и возвращает новый экземпляр Query , который включает в себя все документы в базе данных, которые содержатся в сборе или подколке с данным collectionId .

Подпись:

export declare function collectionGroup(firestore: Firestore, collectionId: string): Query<DocumentData, DocumentData>;

Параметры

Параметр Тип Описание
Firestore Пожарная лавка Ссылка на экземпляр корня Firestore .
CollectionId нить Определяет коллекции, чтобы запросить. Каждая коллекция или субболка с этим идентификатором в качестве последнего сегмента его пути будут включены. Не может содержать черту.

Возврат:

Запрос < DocumentData , DocumentData >

Созданный Query .

ConnectFirestoreemulator (Firestore, Host, Port, Options)

Измените этот экземпляр, чтобы общаться с эмулятором Cloud Firestore.

Подпись:

export declare function connectFirestoreEmulator(firestore: Firestore, host: string, port: number, options?: {
    mockUserToken?: EmulatorMockTokenOptions | string;
}): void;

Параметры

Параметр Тип Описание
Firestore Пожарная лавка Экземпляр Firestore для настройки для подключения к эмулятору.
хозяин нить Ведущий эмулятора (например: Localhost).
порт число порт эмулятора (пример: 9000).
параметры {mockusertoken?: emulatormocktokenoptions | нить; }

Возврат:

пустота

Disablenetwork (Firestore)

Отключает использование сети для этого экземпляра. Он может быть повторно включен через eNablenetWork () . В то время как сеть отключена, любые слушатели снимков, getDoc() или getDocs() вызовы возвращают результаты из кэша, и любые операции записи будут в очереди, пока сеть не будет восстановлена.

Подпись:

export declare function disableNetwork(firestore: Firestore): Promise<void>;

Параметры

Параметр Тип Описание
Firestore Пожарная лавка

Возврат:

Обещание<void>

Promise , которое разрешено после отключения сети.

Док (Firestore, Pathsegments)

Получил экземпляр DocumentReference , который относится к документу на указанном абсолютном пути.

Подпись:

export declare function doc(firestore: Firestore, path: string, ...pathSegments: string[]): DocumentReference<DocumentData, DocumentData>;

Параметры

Параметр Тип Описание
Firestore Пожарная лавка Ссылка на экземпляр корня Firestore .
путь нить Снизительный путь к документу.
пути нить[] Дополнительные сегменты пути, которые будут применены относительно первого аргумента.

Возврат:

DocumentReference < DocumentData , DocumentData >

Экземпляр DocumentReference .

Исключения

Если последний путь имеет нечетное количество сегментов и не указывает на документ.

inableIndExedDbperSistence (Firestore, настойчивости)

Эта функция будет удалена в будущем крупном выпуске. Вместо этого установите FirestoreSettings.localCache на экземпляр PersistentLocalCache , чтобы включить кеш IndexedDB. Вызов этой функции, когда FirestoreSettings.localCache уже указан, вызовет исключение.

Попытки обеспечить постоянное хранилище, если это возможно.

При сбое, enableIndexedDbPersistence() отклонит обещание или бросит исключение. Есть несколько причин, по которым это может потерпеть неудачу, которые могут быть идентифицированы code по ошибке.

* Неудача: приложение уже открыто на другой вкладке браузера. * unimplemented: браузер несовместим с офлайн -внедрением.

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

Постоянство не может быть использована в среде Node.js.

Подпись:

export declare function enableIndexedDbPersistence(firestore: Firestore, persistenceSettings?: PersistenceSettings): Promise<void>;

Параметры

Параметр Тип Описание
Firestore Пожарная лавка Экземпляр Firestore , чтобы обеспечить постоянство.
настойчивости Настойчивости Необязательные настройки объект для настройки постоянства.

Возврат:

Обещание<void>

Promise , которое представляет успешно обеспечивает постоянное хранилище.

EnableMultItAbindExedDbperSistence (Firestore)

Эта функция будет удалена в будущем крупном выпуске. Вместо этого установите FirestoreSettings.localCache на экземпляр PersistentLocalCache , чтобы включить кеш IndexedDB. Вызов этой функции, когда FirestoreSettings.localCache уже указан, вызовет исключение.

Попытки включить многочисленное стойкое хранилище, если это возможно. Если включено во всех вкладках, все операции разделяют доступ к локальной настойчивости, включая общее выполнение запросов и обновления локальных документов, компенсируемых задержкой во всех подключенных экземплярах.

При сбое, enableMultiTabIndexedDbPersistence() отклонит обещание или бросит исключение. Есть несколько причин, по которым это может потерпеть неудачу, которые могут быть идентифицированы code по ошибке.

* Неудачное назначение: приложение уже открыто на другой вкладке браузера, а Multi-Tab не включено. * unimplemented: браузер несовместим с офлайн -внедрением.

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

Подпись:

export declare function enableMultiTabIndexedDbPersistence(firestore: Firestore): Promise<void>;

Параметры

Параметр Тип Описание
Firestore Пожарная лавка Экземпляр Firestore , чтобы обеспечить постоянство.

Возврат:

Обещание<void>

Promise , которое представляет успешно обеспечивает постоянное хранилище.

EnablenetWork (Firestore)

Повторно использует сеть для этого экземпляра Firestore после предыдущего вызова от DipablenetWork () .

Подпись:

export declare function enableNetwork(firestore: Firestore): Promise<void>;

Параметры

Параметр Тип Описание
Firestore Пожарная лавка

Возврат:

Обещание<void>

Promise , которое разрешено после включения сети.

getPersistEntCacheindexmanager (Firestore)

Возвращает диспетчер индекса PersistentCache, используемый данным объектом Firestore .

Экземпляр PersistentCacheIndexManager или null , если локальное постоянное хранилище не используется.

Подпись:

export declare function getPersistentCacheIndexManager(firestore: Firestore): PersistentCacheIndexManager | null;

Параметры

Параметр Тип Описание
Firestore Пожарная лавка

Возврат:

PersistentCacheindexmanager | нулевой

LoadBundle (Firestore, Bundledata)

Загружает пакет Firestore в локальный кеш.

Подпись:

export declare function loadBundle(firestore: Firestore, bundleData: ReadableStream<Uint8Array> | ArrayBuffer | string): LoadBundleTask;

Параметры

Параметр Тип Описание
Firestore Пожарная лавка Экземпляр Firestore для загрузки пучков.
Bundledata ReadableStream <uint8array> | Arraybuffer | нить Объект, представляющий пакет для загрузки. Допустимыми объектами являются ArrayBuffer , ReadableStream<Uint8Array> или string .

Возврат:

LoadBundletask

Объект LoadBundleTask , который уведомляет абонентов с обновлениями прогресса и событиями завершения или ошибок. Его можно использовать в качестве Promise<LoadBundleTaskProgress> .

названной (Firestore, имя)

Читает запрос Firestore из локального кеша, идентифицированный данным именем.

Названные запросы упаковываются в пакеты на стороне сервера (вместе с полученными документами) и загружаются в локальный кэш с помощью loadBundle . Оказавшись в локальном кэше, используйте этот метод, чтобы извлечь запрос по имени.

Подпись:

export declare function namedQuery(firestore: Firestore, name: string): Promise<Query | null>;

Параметры

Параметр Тип Описание
Firestore Пожарная лавка Экземпляр Firestore , чтобы прочитать запрос.
имя нить Имя запроса.

Возврат:

Обещание < Query | ноль>

Promise , которое разрешено с помощью запроса или null .

onsnapshotsinsync (Firestore, Observer)

Прикрепляет слушателя для события снимков в синхронизации. Событие снимков-в-синхронизации указывает на то, что все слушатели, затронутые данным изменением

ПРИМЕЧАНИЕ. Событие снимков в синхронизации указывает только на то, что слушатели синхронизируются друг с другом, но не связаны с тем, синхронизируются ли эти снимки с сервером. Используйте SnapshotMetadata в отдельных слушателях, чтобы определить, является ли снимок из кэша или сервера.

Подпись:

export declare function onSnapshotsInSync(firestore: Firestore, observer: {
    next?: (value: void) => void;
    error?: (error: FirestoreError) => void;
    complete?: () => void;
}): Unsubscribe;

Параметры

Параметр Тип Описание
Firestore Пожарная лавка Пример Firestore для синхронизации снимков.
наблюдатель {Далее ?: (значение: void) => void; Ошибка?: (Ошибка: FirestoreError ) => void; завершить?: () => void; } Один объект, содержащий next и error обратных вызовов.

Возврат:

Отписаться

Функция отказа от подписки, которую можно вызвать для отмены слушателя снимков.

onsnapshotsinsync (Firestore, Onsync)

Прикрепляет слушателя для события снимков в синхронизации. Событие снимков-в-синхронизации указывает на то, что все слушатели, затронутые данным изменением

ПРИМЕЧАНИЕ. Событие снимков в синхронизации указывает только на то, что слушатели синхронизируются друг с другом, но не связаны с тем, синхронизируются ли эти снимки с сервером. Используйте SnapshotMetadata в отдельных слушателях, чтобы определить, является ли снимок из кэша или сервера.

Подпись:

export declare function onSnapshotsInSync(firestore: Firestore, onSync: () => void): Unsubscribe;

Параметры

Параметр Тип Описание
Firestore Пожарная лавка Экземпляр Firestore для синхронизации снимков.
onSync () => недействительно Обратный вызов, который можно вызывать каждый раз, когда все слушатели снимков синхронизируются друг с другом.

Возврат:

Отписаться

Функция отказа от подписки, которую можно вызвать для отмены слушателя снимков.

RunTransaction (Firestore, UpdateFunction, Options)

Выполняет заданную updateFunction , а затем пытается совершить изменения, применяемые в рамках транзакции. Если какой -либо документ прочитал в рамках транзакции, Cloud updateFunction . Если он не может совершить после 5 попыток, транзакция терпит неудачу.

Максимальное количество записей, разрешенных в одной транзакции, составляет 500.

Подпись:

export declare function runTransaction<T>(firestore: Firestore, updateFunction: (transaction: Transaction) => Promise<T>, options?: TransactionOptions): Promise<T>;

Параметры

Параметр Тип Описание
Firestore Пожарная лавка Ссылка на базу данных Firestore для выполнения этой транзакции против.
UpdateFunction (Транзакция: транзакция ) => Обещание <T> Функция для выполнения в контексте транзакции.
параметры Transactionoptions Объект параметров для настройки максимального количества попыток совершить.

Возврат:

Обещание <T>

Если транзакция завершилась успешно или была явно прервана ( updateFunction вернуло неудачное обещание), обещание, возвращаемое updateFunction возвращается сюда. В противном случае, если транзакция не удалась, возвращается отклоненное обещание с соответствующей ошибкой сбоя.

SetIndexConfiguration (Firestore, Configuration)

Этот API предоставляется в качестве предварительного просмотра для разработчиков и может измениться на основе отзывов, которые мы получаем. Не используйте этот API в производственной среде.

Вместо того, чтобы создавать кеш -индексы вручную, рассмотрите возможность использования enablePersistentCacheIndexAutoCreation() , чтобы SDK решал, создавать ли индексы кэша для запросов, работающих локально.

Конфигурирует индексацию для выполнения локального запроса. Любая предыдущая конфигурация индекса переопределена. Promise разрешается после того, как конфигурация индекса сохранилась.

Сами индексные записи созданы асинхронно. Вы можете продолжать использовать запросы, которые требуют индексации, даже если индексы еще не доступны. Заполнение запроса автоматически начнет использование индекса после написания записей индекса.

Индексы поддерживаются только с помощью индексированного постоянства. Если IndexedDB не включена, любая конфигурация индекса игнорируется.

Подпись:

export declare function setIndexConfiguration(firestore: Firestore, configuration: IndexConfiguration): Promise<void>;

Параметры

Параметр Тип Описание
Firestore Пожарная лавка Экземпляр Firestore для настройки индексов для.
конфигурация Индексконфигурация Определение индекса.

Возврат:

Обещание<void>

Promise , которое разрешается, когда все индексы будут успешно настроены.

Исключения

FirestoreError, если формат JSON недействителен.

SetIndexConfiguration (Firestore, JSON)

Этот API предоставляется в качестве предварительного просмотра для разработчиков и может измениться на основе отзывов, которые мы получаем. Не используйте этот API в производственной среде.

Вместо того, чтобы создавать кеш -индексы вручную, рассмотрите возможность использования enablePersistentCacheIndexAutoCreation() , чтобы SDK решал, создавать ли индексы кэша для запросов, работающих локально.

Конфигурирует индексацию для выполнения локального запроса. Любая предыдущая конфигурация индекса переопределена. Promise разрешается после того, как конфигурация индекса сохранилась.

Сами индексные записи созданы асинхронно. Вы можете продолжать использовать запросы, которые требуют индексации, даже если индексы еще не доступны. Заполнение запроса автоматически начнет использование индекса после написания записей индекса.

Индексы поддерживаются только с помощью индексированного постоянства. Вызов enableIndexedDbPersistence() или enableMultiTabIndexedDbPersistence() перед настройкой конфигурации индекса. Если IndexedDB не включена, любая конфигурация индекса игнорируется.

Метод принимает формат JSON, экспортируемый CLI Firebase ( firebase firestore:indexes ). Если формат JSON недействителен, этот метод бросает ошибку.

Подпись:

export declare function setIndexConfiguration(firestore: Firestore, json: string): Promise<void>;

Параметры

Параметр Тип Описание
Firestore Пожарная лавка Экземпляр Firestore для настройки индексов для.
JSON нить Формат JSON, экспортируемый CLI Firebase.

Возврат:

Обещание<void>

Promise , которое разрешается, когда все индексы будут успешно настроены.

Исключения

FirestoreError, если формат JSON недействителен.

прекратить (Firestore)

Прекращает предоставленный экземпляр Firestore .

После вызова terminate() может использоваться только функция clearIndexedDbPersistence() . Любая другая функция бросит FirestoreError .

Чтобы перезапустить после прекращения, создайте новый экземпляр Firebasefirestore с GetFirestore () .

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

Подпись:

export declare function terminate(firestore: Firestore): Promise<void>;

Параметры

Параметр Тип Описание
Firestore Пожарная лавка

Возврат:

Обещание<void>

Promise , которое разрешено, когда экземпляр был успешно прекращен.

WaitForpendingWrites (Firestore)

В ожидании, пока все в настоящее время ожидают записи для активного пользователя, были признаны бэкэнд.

Возвращенное обещание немедленно разрешается, если нет выдающихся записей. В противном случае, обещание ждет всех ранее выпущенных записей (в том числе написанных на предыдущей сессии приложения), но оно не ждет записи, которые были добавлены после вызова функции. Если вы хотите ждать дополнительных записей, позвоните в waitForPendingWrites() снова.

Любые выдающиеся обещания waitForPendingWrites() отклоняются во время изменений пользователей.

Подпись:

export declare function waitForPendingWrites(firestore: Firestore): Promise<void>;

Параметры

Параметр Тип Описание
Firestore Пожарная лавка

Возврат:

Обещание<void>

Promise , которое разрешается, когда все ожидаемые в настоящее время писают, было признано бэкэнд.

writebatch (Firestore)

Создает партию записи, используемую для выполнения нескольких записей в качестве единой атомной операции. Максимальное количество записей, разрешенных в одном Bricebatch, составляет 500.

В отличие от транзакций, записи партии сохраняются в автономном режиме и, следовательно, предпочтительнее, когда вам не нужно устанавливать свои записи в данных чтения.

Подпись:

export declare function writeBatch(firestore: Firestore): WriteBatch;

Параметры

Параметр Тип Описание
Firestore Пожарная лавка

Возврат:

Writebatch

Writebatch , который можно использовать для атомального выполнения нескольких записей.

функция()

считать()

Создайте объект совокупности, который можно использовать для вычисления подсчета документов в наборе результатов запроса.

Подпись:

export declare function count(): AggregateField<number>;

Возврат:

Совокупное поле <номер>

deletefield ()

Возвращает стражи для использования с updatedoc () или setdoc () с {merge: true} чтобы отметить поле для удаления.

Подпись:

export declare function deleteField(): FieldValue;

Возврат:

ПолеЗначение

documentId ()

Возвращает специальный Sentinel FieldPath для обозначения идентификатора документа. Его можно использовать в запросах для сортировки или фильтрации по идентификатору документа.

Подпись:

export declare function documentId(): FieldPath;

Возврат:

ФилдПат

getFirestore ()

Возвращает существующий экземпляр Firestore по умолчанию, который связан с Firebaseapp по умолчанию . Если экземпляра не существует, инициализирует новый экземпляр с настройками по умолчанию.

Подпись:

export declare function getFirestore(): Firestore;

Возврат:

Пожарная лавка

Экземпляр Firestore по умолчанию приложения по умолчанию.

MemoryeAgergargageCollector ()

Создает экземпляр MemoryEagerGarbageCollector . Это также сборщик мусора по умолчанию, если он не указан иным образом.

Подпись:

export declare function memoryEagerGarbageCollector(): MemoryEagerGarbageCollector;

Возврат:

MemoryeAgergargageCollector

PersistentMultipleTabManager ()

Создает пример PersistentMultipleTabManager .

Подпись:

export declare function persistentMultipleTabManager(): PersistentMultipleTabManager;

Возврат:

PersistentMultipleTabManager

servertimestamp ()

Возвращает Sentinel, используемый с setDoc () или updateoc (), чтобы включить сгенерированную сервером временную метку в письменных данных.

Подпись:

export declare function serverTimestamp(): FieldValue;

Возврат:

ПолеЗначение

Функция (Databaseid, ...)

getFirestore (база данных)

Этот API предоставляется в качестве предварительного просмотра для разработчиков и может измениться на основе отзывов, которые мы получаем. Не используйте этот API в производственной среде.

Возвращает существующий названный экземпляр Firestore , который связан с Firebaseapp по умолчанию . Если экземпляра не существует, инициализирует новый экземпляр с настройками по умолчанию.

Подпись:

export declare function getFirestore(databaseId: string): Firestore;

Параметры

Параметр Тип Описание
база данных нить Имя базы данных.

Возврат:

Пожарная лавка

Названный экземпляр Firestore приложения по умолчанию.

функция (элементы, ...)

ArrayRemove (элементы)

Возвращает специальное значение, которое можно использовать с SetDoc () или что говорит серверу удалить заданные элементы из любого значения массива, которое уже существует на сервере. Все экземпляры каждого указанного элемента будут удалены из массива. Если изменение поля еще не является массивом, оно будет перезаписано пустым массивом.

Подпись:

export declare function arrayRemove(...elements: unknown[]): FieldValue;

Параметры

Параметр Тип Описание
элементы неизвестный[] Элементы для удаления из массива.

Возврат:

ПолеЗначение

Sentinel FieldValue для использования в вызове с setDoc() или updateDoc()

Арююнион (элементы)

Возвращает специальное значение, которое можно использовать с setDoc () или updateoc () , которое сообщает серверу объединить заданные элементы с любым значением массива, которое уже существует на сервере. Каждый указанный элемент, который еще не существует в массиве, будет добавлен к концу. Если модифицированное поле еще не является массивом, оно будет перезаписано массивом, содержащим именно указанные элементы.

Подпись:

export declare function arrayUnion(...elements: unknown[]): FieldValue;

Параметры

Параметр Тип Описание
элементы неизвестный[] Элементы в Союз в массив.

Возврат:

ПолеЗначение

Sentinel FieldValue для использования в вызове с setDoc() или updateDoc() .

функция (поле, ...)

средний (поле)

Создайте объект совокупности, который можно использовать для вычисления среднего значения указанного поля в диапазоне документов в наборе результатов запроса.

Подпись:

export declare function average(field: string | FieldPath): AggregateField<number | null>;

Параметры

Параметр Тип Описание
поле строка | ФилдПат Определяет поле, чтобы в среднем через набор результатов.

Возврат:

Совокупное поле <номер | ноль>

сумма (поле)

Создайте объект совокупности, который можно использовать для вычисления суммы указанного поля в диапазоне документов в наборе результатов запроса.

Подпись:

export declare function sum(field: string | FieldPath): AggregateField<number>;

Параметры

Параметр Тип Описание
поле строка | ФилдПат Определяет поле, чтобы суммировать набор результатов.

Возврат:

Совокупное поле <номер>

функция (Fieldpath, ...)

orderby (Fieldpath, Directionstr)

Создает запрос DorderByconstraint , который сортирует результат запроса по указанному полю, необязательно в порядке убывания, а не поднимается.

Подпись:

export declare function orderBy(fieldPath: string | FieldPath, directionStr?: OrderByDirection): QueryOrderByConstraint;

Параметры

Параметр Тип Описание
Полевая дорожка строка | ФилдПат Поле для сортировки.
Направление Порядок работы Необязательное направление для сортировки по ('asc' или 'desc'). Если не указано, порядок будет подниматься.

Возврат:

QueryOrderByConstraint

Созданный запрос DorderByconstraint .

где (Fieldpath, Opstr, значение)

Creates a QueryFieldFilterConstraint that enforces that documents must contain the specified field and that the value should satisfy the relation constraint provided.

Подпись:

export declare function where(fieldPath: string | FieldPath, opStr: WhereFilterOp, value: unknown): QueryFieldFilterConstraint;

Параметры

Параметр Тип Описание
fieldPath строка | ФилдПат The path to compare
opStr WhereFilterOp The operation string (eg "&lt;", "&lt;=", "==", "&lt;", "&lt;=", "!=").
ценить неизвестный The value for comparison

Возврат:

QueryFieldFilterConstraint

The created QueryFieldFilterConstraint .

function(fieldValues, ...)

endAt(fieldValues)

Creates a QueryEndAtConstraint that modifies the result set to end at the provided fields relative to the order of the query. The order of the field values must match the order of the order by clauses of the query.

Подпись:

export declare function endAt(...fieldValues: unknown[]): QueryEndAtConstraint;

Параметры

Параметр Тип Описание
fieldValues неизвестный[] The field values to end this query at, in order of the query's order by.

Возврат:

QueryEndAtConstraint

A QueryEndAtConstraint to pass to query()

endBefore(fieldValues)

Creates a QueryEndAtConstraint that modifies the result set to end before the provided fields relative to the order of the query. The order of the field values must match the order of the order by clauses of the query.

Подпись:

export declare function endBefore(...fieldValues: unknown[]): QueryEndAtConstraint;

Параметры

Параметр Тип Описание
fieldValues неизвестный[] The field values to end this query before, in order of the query's order by.

Возврат:

QueryEndAtConstraint

A QueryEndAtConstraint to pass to query()

startAfter(fieldValues)

Creates a QueryStartAtConstraint that modifies the result set to start after the provided fields relative to the order of the query. The order of the field values must match the order of the order by clauses of the query.

Подпись:

export declare function startAfter(...fieldValues: unknown[]): QueryStartAtConstraint;

Параметры

Параметр Тип Описание
fieldValues неизвестный[] The field values to start this query after, in order of the query's order by.

Возврат:

QueryStartAtConstraint

A QueryStartAtConstraint to pass to query()

startAt(fieldValues)

Creates a QueryStartAtConstraint that modifies the result set to start at the provided fields relative to the order of the query. The order of the field values must match the order of the order by clauses of the query.

Подпись:

export declare function startAt(...fieldValues: unknown[]): QueryStartAtConstraint;

Параметры

Параметр Тип Описание
fieldValues неизвестный[] The field values to start this query at, in order of the query's order by.

Возврат:

QueryStartAtConstraint

A QueryStartAtConstraint to pass to query() .

function(indexManager, ...)

deleteAllPersistentCacheIndexes(indexManager)

Removes all persistent cache indexes.

Please note this function will also deletes indexes generated by setIndexConfiguration() , which is deprecated.

Подпись:

export declare function deleteAllPersistentCacheIndexes(indexManager: PersistentCacheIndexManager): void;

Параметры

Параметр Тип Описание
indexManager PersistentCacheIndexManager

Возврат:

пустота

disablePersistentCacheIndexAutoCreation(indexManager)

Stops creating persistent cache indexes automatically for local query execution. The indexes which have been created by calling enablePersistentCacheIndexAutoCreation() still take effect.

Подпись:

export declare function disablePersistentCacheIndexAutoCreation(indexManager: PersistentCacheIndexManager): void;

Параметры

Параметр Тип Описание
indexManager PersistentCacheIndexManager

Возврат:

пустота

enablePersistentCacheIndexAutoCreation(indexManager)

Enables the SDK to create persistent cache indexes automatically for local query execution when the SDK believes cache indexes can help improve performance.

Эта функция отключена по умолчанию.

Подпись:

export declare function enablePersistentCacheIndexAutoCreation(indexManager: PersistentCacheIndexManager): void;

Параметры

Параметр Тип Описание
indexManager PersistentCacheIndexManager

Возврат:

пустота

function(left, ...)

aggregateFieldEqual(left, right)

Compares two 'AggregateField ` instances for equality.

Подпись:

export declare function aggregateFieldEqual(left: AggregateField<unknown>, right: AggregateField<unknown>): boolean;

Параметры

Параметр Тип Описание
левый AggregateField <неизвестно> Compare this AggregateField to the right .
верно AggregateField <неизвестно> Compare this AggregateField to the left .

Возврат:

логическое значение

aggregateQuerySnapshotEqual(left, right)

Compares two AggregateQuerySnapshot instances for equality.

Two AggregateQuerySnapshot instances are considered "equal" if they have underlying queries that compare equal, and the same data.

Подпись:

export declare function aggregateQuerySnapshotEqual<AggregateSpecType extends AggregateSpec, AppModelType, DbModelType extends DocumentData>(left: AggregateQuerySnapshot<AggregateSpecType, AppModelType, DbModelType>, right: AggregateQuerySnapshot<AggregateSpecType, AppModelType, DbModelType>): boolean;

Параметры

Параметр Тип Описание
левый AggregateQuerySnapshot <AggregateSpecType, AppModelType, DbModelType> The first AggregateQuerySnapshot to compare.
верно AggregateQuerySnapshot <AggregateSpecType, AppModelType, DbModelType> The second AggregateQuerySnapshot to compare.

Возврат:

логическое значение

true if the objects are "equal", as defined above, or false otherwise.

queryEqual(left, right)

Returns true if the provided queries point to the same collection and apply the same constraints.

Подпись:

export declare function queryEqual<AppModelType, DbModelType extends DocumentData>(left: Query<AppModelType, DbModelType>, right: Query<AppModelType, DbModelType>): boolean;

Параметры

Параметр Тип Описание
левый Запрос <AppModelType, DbModelType> A Query to compare.
верно Запрос <AppModelType, DbModelType> A Query to compare.

Возврат:

логическое значение

true if the references point to the same location in the same Firestore database.

refEqual(left, right)

Returns true if the provided references are equal.

Подпись:

export declare function refEqual<AppModelType, DbModelType extends DocumentData>(left: DocumentReference<AppModelType, DbModelType> | CollectionReference<AppModelType, DbModelType>, right: DocumentReference<AppModelType, DbModelType> | CollectionReference<AppModelType, DbModelType>): boolean;

Параметры

Параметр Тип Описание
левый DocumentReference <AppModelType, DbModelType> | CollectionReference <AppModelType, DbModelType> A reference to compare.
верно DocumentReference <AppModelType, DbModelType> | CollectionReference <AppModelType, DbModelType> A reference to compare.

Возврат:

логическое значение

true if the references point to the same location in the same Firestore database.

snapshotEqual(left, right)

Returns true if the provided snapshots are equal.

Подпись:

export declare function snapshotEqual<AppModelType, DbModelType extends DocumentData>(left: DocumentSnapshot<AppModelType, DbModelType> | QuerySnapshot<AppModelType, DbModelType>, right: DocumentSnapshot<AppModelType, DbModelType> | QuerySnapshot<AppModelType, DbModelType>): boolean;

Параметры

Параметр Тип Описание
левый Снимок документа <AppModelType, DbModelType> | QuerySnapshot <AppModelType, DbModelType> A snapshot to compare.
верно Снимок документа <AppModelType, DbModelType> | QuerySnapshot <AppModelType, DbModelType> A snapshot to compare.

Возврат:

логическое значение

true if the snapshots are equal.

function(limit, ...)

limit(limit)

Creates a QueryLimitConstraint that only returns the first matching documents.

Подпись:

export declare function limit(limit: number): QueryLimitConstraint;

Параметры

Параметр Тип Описание
предел число The maximum number of items to return.

Возврат:

QueryLimitConstraint

The created QueryLimitConstraint .

limitToLast(limit)

Creates a QueryLimitConstraint that only returns the last matching documents.

You must specify at least one orderBy clause for limitToLast queries, otherwise an exception will be thrown during execution.

Подпись:

export declare function limitToLast(limit: number): QueryLimitConstraint;

Параметры

Параметр Тип Описание
предел число The maximum number of items to return.

Возврат:

QueryLimitConstraint

The created QueryLimitConstraint .

функция (logLevel, ...)

setLogLevel (уровень журнала)

Sets the verbosity of Cloud Firestore logs (debug, error, or silent).

Подпись:

export declare function setLogLevel(logLevel: LogLevel): void;

Параметры

Параметр Тип Описание
уровень журнала LogLevel The verbosity you set for activity and error logging. Can be any of the following values:
  • debug for the most verbose logging level, primarily for debugging.
  • error to log errors only.
  • silent to turn off logging.

Возврат:

пустота

function(n, ...)

increment(n)

Returns a special value that can be used with setDoc() or updateDoc() that tells the server to increment the field's current value by the given value.

If either the operand or the current field value uses floating point precision, all arithmetic follows IEEE 754 semantics. If both values are integers, values outside of JavaScript's safe number range ( Number.MIN_SAFE_INTEGER to Number.MAX_SAFE_INTEGER ) are also subject to precision loss. Furthermore, once processed by the Firestore backend, all integer operations are capped between -2^63 and 2^63-1.

If the current field value is not of type number , or if the field does not yet exist, the transformation sets the field to the given value.

Подпись:

export declare function increment(n: number): FieldValue;

Параметры

Параметр Тип Описание
н число The value to increment by.

Возврат:

ПолеЗначение

The FieldValue sentinel for use in a call to setDoc() or updateDoc()

function(query, ...)

getAggregateFromServer(query, aggregateSpec)

Calculates the specified aggregations over the documents in the result set of the given query without actually downloading the documents.

Using this function to perform aggregations is efficient because only the final aggregation values, not the documents' data, are downloaded. This function can perform aggregations of the documents in cases where the result set is prohibitively large to download entirely (thousands of documents).

The result received from the server is presented, unaltered, without considering any local state. That is, documents in the local cache are not taken into consideration, neither are local modifications not yet synchronized with the server. Previously-downloaded results, if any, are not used. Every invocation of this function necessarily involves a round trip to the server.

Подпись:

export declare function getAggregateFromServer<AggregateSpecType extends AggregateSpec, AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>, aggregateSpec: AggregateSpecType): Promise<AggregateQuerySnapshot<AggregateSpecType, AppModelType, DbModelType>>;

Параметры

Параметр Тип Описание
запрос Запрос <AppModelType, DbModelType> The query whose result set is aggregated over.
aggregateSpec AggregateSpecType An AggregateSpec object that specifies the aggregates to perform over the result set. The AggregateSpec specifies aliases for each aggregate, which can be used to retrieve the aggregate result.

Возврат:

Promise< AggregateQuerySnapshot <AggregateSpecType, AppModelType, DbModelType>>

Пример

const aggregateSnapshot = await getAggregateFromServer(query, {
  countOfDocs: count(),
  totalHours: sum('hours'),
  averageScore: average('score')
});

const countOfDocs: number = aggregateSnapshot.data().countOfDocs;
const totalHours: number = aggregateSnapshot.data().totalHours;
const averageScore: number | null = aggregateSnapshot.data().averageScore;

getCountFromServer(query)

Calculates the number of documents in the result set of the given query without actually downloading the documents.

Using this function to count the documents is efficient because only the final count, not the documents' data, is downloaded. This function can count the documents in cases where the result set is prohibitively large to download entirely (thousands of documents).

The result received from the server is presented, unaltered, without considering any local state. That is, documents in the local cache are not taken into consideration, neither are local modifications not yet synchronized with the server. Previously-downloaded results, if any, are not used. Every invocation of this function necessarily involves a round trip to the server.

Подпись:

export declare function getCountFromServer<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>): Promise<AggregateQuerySnapshot<{
    count: AggregateField<number>;
}, AppModelType, DbModelType>>;

Параметры

Параметр Тип Описание
запрос Запрос <AppModelType, DbModelType> The query whose result set size is calculated.

Возврат:

Promise< AggregateQuerySnapshot <{ count: AggregateField <number>; }, AppModelType, DbModelType>>

A Promise that will be resolved with the count; the count can be retrieved from snapshot.data().count , where snapshot is the AggregateQuerySnapshot to which the returned Promise resolves.

getDocs(query)

Executes the query and returns the results as a QuerySnapshot .

Подпись:

export declare function getDocs<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>): Promise<QuerySnapshot<AppModelType, DbModelType>>;

Параметры

Параметр Тип Описание
запрос Запрос <AppModelType, DbModelType>

Возврат:

Promise< QuerySnapshot <AppModelType, DbModelType>>

A Promise that will be resolved with the results of the query.

getDocsFromCache(query)

Executes the query and returns the results as a QuerySnapshot from cache. Returns an empty result set if no documents matching the query are currently cached.

Подпись:

export declare function getDocsFromCache<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>): Promise<QuerySnapshot<AppModelType, DbModelType>>;

Параметры

Параметр Тип Описание
запрос Запрос <AppModelType, DbModelType>

Возврат:

Promise< QuerySnapshot <AppModelType, DbModelType>>

A Promise that will be resolved with the results of the query.

getDocsFromServer(query)

Executes the query and returns the results as a QuerySnapshot from the server. Returns an error if the network is not available.

Подпись:

export declare function getDocsFromServer<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>): Promise<QuerySnapshot<AppModelType, DbModelType>>;

Параметры

Параметр Тип Описание
запрос Запрос <AppModelType, DbModelType>

Возврат:

Promise< QuerySnapshot <AppModelType, DbModelType>>

A Promise that will be resolved with the results of the query.

onSnapshot(query, observer)

Attaches a listener for QuerySnapshot events. You may either pass individual onNext and onError callbacks or pass a single observer object with next and error callbacks. The listener can be cancelled by calling the function that is returned when onSnapshot is called.

NOTE: Although an onCompletion callback can be provided, it will never be called because the snapshot stream is never-ending.

Подпись:

export declare function onSnapshot<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>, observer: {
    next?: (snapshot: QuerySnapshot<AppModelType, DbModelType>) => void;
    error?: (error: FirestoreError) => void;
    complete?: () => void;
}): Unsubscribe;

Параметры

Параметр Тип Описание
запрос Запрос <AppModelType, DbModelType> The query to listen to.
наблюдатель { next?: (snapshot: QuerySnapshot <AppModelType, DbModelType>) => void; error?: (error: FirestoreError ) => void; complete?: () => void; } A single object containing next and error callbacks.

Возврат:

Отписаться

An unsubscribe function that can be called to cancel the snapshot listener.

onSnapshot(query, options, observer)

Attaches a listener for QuerySnapshot events. You may either pass individual onNext and onError callbacks or pass a single observer object with next and error callbacks. The listener can be cancelled by calling the function that is returned when onSnapshot is called.

NOTE: Although an onCompletion callback can be provided, it will never be called because the snapshot stream is never-ending.

Подпись:

export declare function onSnapshot<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>, options: SnapshotListenOptions, observer: {
    next?: (snapshot: QuerySnapshot<AppModelType, DbModelType>) => void;
    error?: (error: FirestoreError) => void;
    complete?: () => void;
}): Unsubscribe;

Параметры

Параметр Тип Описание
запрос Запрос <AppModelType, DbModelType> The query to listen to.
параметры SnapshotListenOptions Options controlling the listen behavior.
наблюдатель { next?: (snapshot: QuerySnapshot <AppModelType, DbModelType>) => void; error?: (error: FirestoreError ) => void; complete?: () => void; } A single object containing next and error callbacks.

Возврат:

Отписаться

An unsubscribe function that can be called to cancel the snapshot listener.

onSnapshot(query, onNext, onError, onCompletion)

Attaches a listener for QuerySnapshot events. You may either pass individual onNext and onError callbacks or pass a single observer object with next and error callbacks. The listener can be cancelled by calling the function that is returned when onSnapshot is called.

NOTE: Although an onCompletion callback can be provided, it will never be called because the snapshot stream is never-ending.

Подпись:

export declare function onSnapshot<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>, onNext: (snapshot: QuerySnapshot<AppModelType, DbModelType>) => void, onError?: (error: FirestoreError) => void, onCompletion?: () => void): Unsubscribe;

Параметры

Параметр Тип Описание
запрос Запрос <AppModelType, DbModelType> The query to listen to.
onNext (snapshot: QuerySnapshot <AppModelType, DbModelType>) => void A callback to be called every time a new QuerySnapshot is available.
onError (error: FirestoreError ) => void A callback to be called if the listen fails or is cancelled. No further callbacks will occur.
onCompletion () => недействительно Can be provided, but will not be called since streams are never ending.

Возврат:

Отписаться

An unsubscribe function that can be called to cancel the snapshot listener.

onSnapshot(query, options, onNext, onError, onCompletion)

Attaches a listener for QuerySnapshot events. You may either pass individual onNext and onError callbacks or pass a single observer object with next and error callbacks. The listener can be cancelled by calling the function that is returned when onSnapshot is called.

NOTE: Although an onCompletion callback can be provided, it will never be called because the snapshot stream is never-ending.

Подпись:

export declare function onSnapshot<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>, options: SnapshotListenOptions, onNext: (snapshot: QuerySnapshot<AppModelType, DbModelType>) => void, onError?: (error: FirestoreError) => void, onCompletion?: () => void): Unsubscribe;

Параметры

Параметр Тип Описание
запрос Запрос <AppModelType, DbModelType> The query to listen to.
параметры SnapshotListenOptions Options controlling the listen behavior.
onNext (snapshot: QuerySnapshot <AppModelType, DbModelType>) => void A callback to be called every time a new QuerySnapshot is available.
onError (error: FirestoreError ) => void A callback to be called if the listen fails or is cancelled. No further callbacks will occur.
onCompletion () => недействительно Can be provided, but will not be called since streams are never ending.

Возврат:

Отписаться

An unsubscribe function that can be called to cancel the snapshot listener.

query(query, compositeFilter, queryConstraints)

Creates a new immutable instance of Query that is extended to also include additional query constraints.

Подпись:

export declare function query<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>, compositeFilter: QueryCompositeFilterConstraint, ...queryConstraints: QueryNonFilterConstraint[]): Query<AppModelType, DbModelType>;

Параметры

Параметр Тип Описание
запрос Запрос <AppModelType, DbModelType> The Query instance to use as a base for the new constraints.
compositeFilter QueryCompositeFilterConstraint The QueryCompositeFilterConstraint to apply. Create QueryCompositeFilterConstraint using and() or or() .
queryConstraints QueryNonFilterConstraint [] Additional QueryNonFilterConstraint s to apply (eg orderBy() , limit() ).

Возврат:

Запрос <AppModelType, DbModelType>

Исключения

if any of the provided query constraints cannot be combined with the existing or new constraints.

query(query, queryConstraints)

Creates a new immutable instance of Query that is extended to also include additional query constraints.

Подпись:

export declare function query<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>, ...queryConstraints: QueryConstraint[]): Query<AppModelType, DbModelType>;

Параметры

Параметр Тип Описание
запрос Запрос <AppModelType, DbModelType> The Query instance to use as a base for the new constraints.
queryConstraints QueryConstraint [] The list of QueryConstraint s to apply.

Возврат:

Запрос <AppModelType, DbModelType>

Исключения

if any of the provided query constraints cannot be combined with the existing or new constraints.

function(queryConstraints, ...)

and(queryConstraints)

Creates a new QueryCompositeFilterConstraint that is a conjunction of the given filter constraints. A conjunction filter includes a document if it satisfies all of the given filters.

Подпись:

export declare function and(...queryConstraints: QueryFilterConstraint[]): QueryCompositeFilterConstraint;

Параметры

Параметр Тип Описание
queryConstraints QueryFilterConstraint [] Необязательный. The list of QueryFilterConstraint s to perform a conjunction for. These must be created with calls to where() , или() , or and() .

Возврат:

QueryCompositeFilterConstraint

The newly created QueryCompositeFilterConstraint .

or(queryConstraints)

Creates a new QueryCompositeFilterConstraint that is a disjunction of the given filter constraints. A disjunction filter includes a document if it satisfies any of the given filters.

Подпись:

export declare function or(...queryConstraints: QueryFilterConstraint[]): QueryCompositeFilterConstraint;

Параметры

Параметр Тип Описание
queryConstraints QueryFilterConstraint [] Необязательный. The list of QueryFilterConstraint s to perform a disjunction for. These must be created with calls to where() , или() , or and() .

Возврат:

QueryCompositeFilterConstraint

The newly created QueryCompositeFilterConstraint .

function(reference, ...)

addDoc(reference, data)

Add a new document to specified CollectionReference with the given data, assigning it a document ID automatically.

Подпись:

export declare function addDoc<AppModelType, DbModelType extends DocumentData>(reference: CollectionReference<AppModelType, DbModelType>, data: WithFieldValue<AppModelType>): Promise<DocumentReference<AppModelType, DbModelType>>;

Параметры

Параметр Тип Описание
ссылка CollectionReference <AppModelType, DbModelType> A reference to the collection to add this document to.
данные WithFieldValue <AppModelType> An Object containing the data for the new document.

Возврат:

Promise< DocumentReference <AppModelType, DbModelType>>

A Promise resolved with a DocumentReference pointing to the newly created document after it has been written to the backend (Note that it won't resolve while you're offline).

collection(reference, path, pathSegments)

Gets a CollectionReference instance that refers to a subcollection of reference at the specified relative path.

Подпись:

export declare function collection<AppModelType, DbModelType extends DocumentData>(reference: CollectionReference<AppModelType, DbModelType>, path: string, ...pathSegments: string[]): CollectionReference<DocumentData, DocumentData>;

Параметры

Параметр Тип Описание
ссылка CollectionReference <AppModelType, DbModelType> A reference to a collection.
путь нить A slash-separated path to a collection.
pathSegments нить[] Additional path segments to apply relative to the first argument.

Возврат:

CollectionReference < DocumentData , DocumentData >

The CollectionReference instance.

Исключения

If the final path has an even number of segments and does not point to a collection.

collection(reference, path, pathSegments)

Gets a CollectionReference instance that refers to a subcollection of reference at the specified relative path.

Подпись:

export declare function collection<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, path: string, ...pathSegments: string[]): CollectionReference<DocumentData, DocumentData>;

Параметры

Параметр Тип Описание
ссылка DocumentReference <AppModelType, DbModelType> A reference to a Firestore document.
путь нить A slash-separated path to a collection.
pathSegments нить[] Additional path segments that will be applied relative to the first argument.

Возврат:

CollectionReference < DocumentData , DocumentData >

The CollectionReference instance.

Исключения

If the final path has an even number of segments and does not point to a collection.

deleteDoc(reference)

Deletes the document referred to by the specified DocumentReference .

Подпись:

export declare function deleteDoc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>): Promise<void>;

Параметры

Параметр Тип Описание
ссылка DocumentReference <AppModelType, DbModelType> A reference to the document to delete.

Возврат:

Обещание<void>

A Promise resolved once the document has been successfully deleted from the backend (note that it won't resolve while you're offline).

doc(reference, path, pathSegments)

Gets a DocumentReference instance that refers to a document within reference at the specified relative path. If no path is specified, an automatically-generated unique ID will be used for the returned DocumentReference .

Подпись:

export declare function doc<AppModelType, DbModelType extends DocumentData>(reference: CollectionReference<AppModelType, DbModelType>, path?: string, ...pathSegments: string[]): DocumentReference<AppModelType, DbModelType>;

Параметры

Параметр Тип Описание
ссылка CollectionReference <AppModelType, DbModelType> A reference to a collection.
путь нить A slash-separated path to a document. Has to be omitted to use auto-generated IDs.
pathSegments нить[] Additional path segments that will be applied relative to the first argument.

Возврат:

DocumentReference <AppModelType, DbModelType>

The DocumentReference instance.

Исключения

If the final path has an odd number of segments and does not point to a document.

doc(reference, path, pathSegments)

Gets a DocumentReference instance that refers to a document within reference at the specified relative path.

Подпись:

export declare function doc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, path: string, ...pathSegments: string[]): DocumentReference<DocumentData, DocumentData>;

Параметры

Параметр Тип Описание
ссылка DocumentReference <AppModelType, DbModelType> A reference to a Firestore document.
путь нить A slash-separated path to a document.
pathSegments нить[] Additional path segments that will be applied relative to the first argument.

Возврат:

DocumentReference < DocumentData , DocumentData >

The DocumentReference instance.

Исключения

If the final path has an odd number of segments and does not point to a document.

getDoc(reference)

Reads the document referred to by this DocumentReference .

Подпись:

export declare function getDoc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>): Promise<DocumentSnapshot<AppModelType, DbModelType>>;

Параметры

Параметр Тип Описание
ссылка DocumentReference <AppModelType, DbModelType> The reference of the document to fetch.

Возврат:

Promise< DocumentSnapshot <AppModelType, DbModelType>>

A Promise resolved with a DocumentSnapshot containing the current document contents.

getDocFromCache(reference)

Reads the document referred to by this DocumentReference from cache. Returns an error if the document is not currently cached.

Подпись:

export declare function getDocFromCache<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>): Promise<DocumentSnapshot<AppModelType, DbModelType>>;

Параметры

Параметр Тип Описание
ссылка DocumentReference <AppModelType, DbModelType>

Возврат:

Promise< DocumentSnapshot <AppModelType, DbModelType>>

A Promise resolved with a DocumentSnapshot containing the current document contents.

getDocFromServer(reference)

Reads the document referred to by this DocumentReference from the server. Returns an error if the network is not available.

Подпись:

export declare function getDocFromServer<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>): Promise<DocumentSnapshot<AppModelType, DbModelType>>;

Параметры

Параметр Тип Описание
ссылка DocumentReference <AppModelType, DbModelType>

Возврат:

Promise< DocumentSnapshot <AppModelType, DbModelType>>

A Promise resolved with a DocumentSnapshot containing the current document contents.

onSnapshot(reference, observer)

Attaches a listener for DocumentSnapshot events. You may either pass individual onNext and onError callbacks or pass a single observer object with next and error callbacks.

NOTE: Although an onCompletion callback can be provided, it will never be called because the snapshot stream is never-ending.

Подпись:

export declare function onSnapshot<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, observer: {
    next?: (snapshot: DocumentSnapshot<AppModelType, DbModelType>) => void;
    error?: (error: FirestoreError) => void;
    complete?: () => void;
}): Unsubscribe;

Параметры

Параметр Тип Описание
ссылка DocumentReference <AppModelType, DbModelType> A reference to the document to listen to.
наблюдатель { next?: (snapshot: DocumentSnapshot <AppModelType, DbModelType>) => void; error?: (error: FirestoreError ) => void; complete?: () => void; } A single object containing next and error callbacks.

Возврат:

Отписаться

An unsubscribe function that can be called to cancel the snapshot listener.

onSnapshot(reference, options, observer)

Attaches a listener for DocumentSnapshot events. You may either pass individual onNext and onError callbacks or pass a single observer object with next and error callbacks.

NOTE: Although an onCompletion callback can be provided, it will never be called because the snapshot stream is never-ending.

Подпись:

export declare function onSnapshot<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, options: SnapshotListenOptions, observer: {
    next?: (snapshot: DocumentSnapshot<AppModelType, DbModelType>) => void;
    error?: (error: FirestoreError) => void;
    complete?: () => void;
}): Unsubscribe;

Параметры

Параметр Тип Описание
ссылка DocumentReference <AppModelType, DbModelType> A reference to the document to listen to.
параметры SnapshotListenOptions Options controlling the listen behavior.
наблюдатель { next?: (snapshot: DocumentSnapshot <AppModelType, DbModelType>) => void; error?: (error: FirestoreError ) => void; complete?: () => void; } A single object containing next and error callbacks.

Возврат:

Отписаться

An unsubscribe function that can be called to cancel the snapshot listener.

onSnapshot(reference, onNext, onError, onCompletion)

Attaches a listener for DocumentSnapshot events. You may either pass individual onNext and onError callbacks or pass a single observer object with next and error callbacks.

NOTE: Although an onCompletion callback can be provided, it will never be called because the snapshot stream is never-ending.

Подпись:

export declare function onSnapshot<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, onNext: (snapshot: DocumentSnapshot<AppModelType, DbModelType>) => void, onError?: (error: FirestoreError) => void, onCompletion?: () => void): Unsubscribe;

Параметры

Параметр Тип Описание
ссылка DocumentReference <AppModelType, DbModelType> A reference to the document to listen to.
onNext (snapshot: DocumentSnapshot <AppModelType, DbModelType>) => void A callback to be called every time a new DocumentSnapshot is available.
onError (error: FirestoreError ) => void A callback to be called if the listen fails or is cancelled. No further callbacks will occur.
onCompletion () => недействительно Can be provided, but will not be called since streams are never ending.

Возврат:

Отписаться

An unsubscribe function that can be called to cancel the snapshot listener.

onSnapshot(reference, options, onNext, onError, onCompletion)

Attaches a listener for DocumentSnapshot events. You may either pass individual onNext and onError callbacks or pass a single observer object with next and error callbacks.

NOTE: Although an onCompletion callback can be provided, it will never be called because the snapshot stream is never-ending.

Подпись:

export declare function onSnapshot<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, options: SnapshotListenOptions, onNext: (snapshot: DocumentSnapshot<AppModelType, DbModelType>) => void, onError?: (error: FirestoreError) => void, onCompletion?: () => void): Unsubscribe;

Параметры

Параметр Тип Описание
ссылка DocumentReference <AppModelType, DbModelType> A reference to the document to listen to.
параметры SnapshotListenOptions Options controlling the listen behavior.
onNext (snapshot: DocumentSnapshot <AppModelType, DbModelType>) => void A callback to be called every time a new DocumentSnapshot is available.
onError (error: FirestoreError ) => void A callback to be called if the listen fails or is cancelled. No further callbacks will occur.
onCompletion () => недействительно Can be provided, but will not be called since streams are never ending.

Возврат:

Отписаться

An unsubscribe function that can be called to cancel the snapshot listener.

setDoc(reference, data)

Writes to the document referred to by this DocumentReference . If the document does not yet exist, it will be created.

Подпись:

export declare function setDoc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, data: WithFieldValue<AppModelType>): Promise<void>;

Параметры

Параметр Тип Описание
ссылка DocumentReference <AppModelType, DbModelType> A reference to the document to write.
данные WithFieldValue <AppModelType> A map of the fields and values for the document.

Возврат:

Обещание<void>

A Promise resolved once the data has been successfully written to the backend (note that it won't resolve while you're offline).

setDoc(reference, data, options)

Writes to the document referred to by the specified DocumentReference . If the document does not yet exist, it will be created. If you provide merge or mergeFields , the provided data can be merged into an existing document.

Подпись:

export declare function setDoc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, data: PartialWithFieldValue<AppModelType>, options: SetOptions): Promise<void>;

Параметры

Параметр Тип Описание
ссылка DocumentReference <AppModelType, DbModelType> A reference to the document to write.
данные PartialWithFieldValue <AppModelType> A map of the fields and values for the document.
параметры SetOptions An object to configure the set behavior.

Возврат:

Обещание<void>

A Promise resolved once the data has been successfully written to the backend (note that it won't resolve while you're offline).

updateDoc(reference, data)

Updates fields in the document referred to by the specified DocumentReference . The update will fail if applied to a document that does not exist.

Подпись:

export declare function updateDoc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, data: UpdateData<DbModelType>): Promise<void>;

Параметры

Параметр Тип Описание
ссылка DocumentReference <AppModelType, DbModelType> A reference to the document to update.
данные UpdateData <DbModelType> An object containing the fields and values with which to update the document. Fields can contain dots to reference nested fields within the document.

Возврат:

Обещание<void>

A Promise resolved once the data has been successfully written to the backend (note that it won't resolve while you're offline).

updateDoc(reference, field, value, moreFieldsAndValues)

Updates fields in the document referred to by the specified DocumentReference The update will fail if applied to a document that does not exist.

Nested fields can be updated by providing dot-separated field path strings or by providing FieldPath objects.

Подпись:

export declare function updateDoc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, field: string | FieldPath, value: unknown, ...moreFieldsAndValues: unknown[]): Promise<void>;

Параметры

Параметр Тип Описание
ссылка DocumentReference <AppModelType, DbModelType> A reference to the document to update.
поле строка | ФилдПат The first field to update.
ценить неизвестный The first value.
moreFieldsAndValues неизвестный[] Additional key value pairs.

Возврат:

Обещание<void>

A Promise resolved once the data has been successfully written to the backend (note that it won't resolve while you're offline).

function(settings, ...)

memoryLocalCache(settings)

Creates an instance of MemoryLocalCache . The instance can be set to FirestoreSettings.cache to tell the SDK which cache layer to use.

Подпись:

export declare function memoryLocalCache(settings?: MemoryCacheSettings): MemoryLocalCache;

Параметры

Параметр Тип Описание
настройки MemoryCacheSettings

Возврат:

MemoryLocalCache

memoryLruGarbageCollector(settings)

Creates an instance of MemoryLruGarbageCollector .

A target size can be specified as part of the setting parameter. The collector will start deleting documents once the cache size exceeds the given size. The default cache size is 40MB (40 * 1024 * 1024 bytes).

Подпись:

export declare function memoryLruGarbageCollector(settings?: {
    cacheSizeBytes?: number;
}): MemoryLruGarbageCollector;

Параметры

Параметр Тип Описание
настройки { cacheSizeBytes?: number; }

Возврат:

MemoryLruGarbageCollector

persistentLocalCache(settings)

Creates an instance of PersistentLocalCache . The instance can be set to FirestoreSettings.cache to tell the SDK which cache layer to use.

Persistent cache cannot be used in a Node.js environment.

Подпись:

export declare function persistentLocalCache(settings?: PersistentCacheSettings): PersistentLocalCache;

Параметры

Параметр Тип Описание
настройки PersistentCacheSettings

Возврат:

PersistentLocalCache

persistentSingleTabManager(settings)

Creates an instance of PersistentSingleTabManager .

Подпись:

export declare function persistentSingleTabManager(settings: PersistentSingleTabManagerSettings | undefined): PersistentSingleTabManager;

Параметры

Параметр Тип Описание
настройки PersistentSingleTabManagerSettings | неопределенный Configures the created tab manager.

Возврат:

PersistentSingleTabManager

function(snapshot, ...)

endAt(snapshot)

Creates a QueryEndAtConstraint that modifies the result set to end at the provided document (inclusive). The end position is relative to the order of the query. The document must contain all of the fields provided in the orderBy of the query.

Подпись:

export declare function endAt<AppModelType, DbModelType extends DocumentData>(snapshot: DocumentSnapshot<AppModelType, DbModelType>): QueryEndAtConstraint;

Параметры

Параметр Тип Описание
снимок Снимок документа <AppModelType, DbModelType> The snapshot of the document to end at.

Возврат:

QueryEndAtConstraint

A QueryEndAtConstraint to pass to query()

endBefore(snapshot)

Creates a QueryEndAtConstraint that modifies the result set to end before the provided document (exclusive). The end position is relative to the order of the query. The document must contain all of the fields provided in the orderBy of the query.

Подпись:

export declare function endBefore<AppModelType, DbModelType extends DocumentData>(snapshot: DocumentSnapshot<AppModelType, DbModelType>): QueryEndAtConstraint;

Параметры

Параметр Тип Описание
снимок Снимок документа <AppModelType, DbModelType> The snapshot of the document to end before.

Возврат:

QueryEndAtConstraint

A QueryEndAtConstraint to pass to query()

startAfter(snapshot)

Creates a QueryStartAtConstraint that modifies the result set to start after the provided document (exclusive). The starting position is relative to the order of the query. The document must contain all of the fields provided in the orderBy of the query.

Подпись:

export declare function startAfter<AppModelType, DbModelType extends DocumentData>(snapshot: DocumentSnapshot<AppModelType, DbModelType>): QueryStartAtConstraint;

Параметры

Параметр Тип Описание
снимок Снимок документа <AppModelType, DbModelType> The snapshot of the document to start after.

Возврат:

QueryStartAtConstraint

A QueryStartAtConstraint to pass to query()

startAt(snapshot)

Creates a QueryStartAtConstraint that modifies the result set to start at the provided document (inclusive). The starting position is relative to the order of the query. The document must contain all of the fields provided in the orderBy of this query.

Подпись:

export declare function startAt<AppModelType, DbModelType extends DocumentData>(snapshot: DocumentSnapshot<AppModelType, DbModelType>): QueryStartAtConstraint;

Параметры

Параметр Тип Описание
снимок Снимок документа <AppModelType, DbModelType> The snapshot of the document to start at.

Возврат:

QueryStartAtConstraint

A QueryStartAtConstraint to pass to query() .

function(values, ...)

vector(values)

Creates a new VectorValue constructed with a copy of the given array of numbers.

Подпись:

export declare function vector(values?: number[]): VectorValue;

Параметры

Параметр Тип Описание
ценности число[] Create a VectorValue instance with a copy of this array of numbers.

Возврат:

VectorValue

A new VectorValue constructed with a copy of the given array of numbers.

CACHE_SIZE_UNLIMITED

Constant used to indicate the LRU garbage collection should be disabled. Set this value as the cacheSizeBytes on the settings passed to the Firestore instance.

Подпись:

CACHE_SIZE_UNLIMITED = -1

AddPrefixToKeys

Returns a new map where every key is prefixed with the outer key appended to a dot.

Подпись:

export declare type AddPrefixToKeys<Prefix extends string, T extends Record<string, unknown>> = {
    [K in keyof T & string as `${Prefix}.${K}`]+?: string extends K ? any : T[K];
};

AggregateFieldType

The union of all AggregateField types that are supported by Firestore.

Подпись:

export declare type AggregateFieldType = ReturnType<typeof sum> | ReturnType<typeof average> | ReturnType<typeof count>;

AggregateSpecData

A type whose keys are taken from an AggregateSpec , and whose values are the result of the aggregation performed by the corresponding AggregateField from the input AggregateSpec .

Подпись:

export declare type AggregateSpecData<T extends AggregateSpec> = {
    [P in keyof T]: T[P] extends AggregateField<infer U> ? U : never;
};

AggregateType

Union type representing the aggregate type to be performed.

Подпись:

export declare type AggregateType = 'count' | 'avg' | 'sum';

ChildUpdateFields

Helper for calculating the nested fields for a given type T1. This is needed to distribute union types such as undefined | {...} (happens for optional props) or {a: A} | {b: B} .

In this use case, V is used to distribute the union types of T[K] on Record , since T[K] is evaluated as an expression and not distributed.

See https://www.typescriptlang.org/docs/handbook/advanced-types.html#distributive-conditional-types

Подпись:

export declare type ChildUpdateFields<K extends string, V> = V extends Record<string, unknown> ? AddPrefixToKeys<K, UpdateData<V>> : never;

DocumentChangeType

The type of a DocumentChange may be 'added', 'removed', or 'modified'.

Подпись:

export declare type DocumentChangeType = 'added' | 'removed' | 'modified';

FirestoreErrorCode

The set of Firestore status codes. The codes are the same at the ones exposed by gRPC here: https://github.com/grpc/grpc/blob/master/doc/statuscodes.md

Possible values: - 'cancelled': The operation was cancelled (typically by the caller). - 'unknown': Unknown error or an error from a different error domain. - 'invalid-argument': Client specified an invalid argument. Note that this differs from 'failed-precondition'. 'invalid-argument' indicates arguments that are problematic regardless of the state of the system (eg an invalid field name). - 'deadline-exceeded': Deadline expired before operation could complete. For operations that change the state of the system, this error may be returned even if the operation has completed successfully. For example, a successful response from a server could have been delayed long enough for the deadline to expire. - 'not-found': Some requested document was not found. - 'already-exists': Some document that we attempted to create already exists. - 'permission-denied': The caller does not have permission to execute the specified operation. - 'resource-exhausted': Some resource has been exhausted, perhaps a per-user quota, or perhaps the entire file system is out of space. - 'failed-precondition': Operation was rejected because the system is not in a state required for the operation's execution. - 'aborted': The operation was aborted, typically due to a concurrency issue like transaction aborts, etc. - 'out-of-range': Operation was attempted past the valid range. - 'unimplemented': Operation is not implemented or not supported/enabled. - 'internal': Internal errors. Means some invariants expected by underlying system has been broken. If you see one of these errors, something is very broken. - 'unavailable': The service is currently unavailable. This is most likely a transient condition and may be corrected by retrying with a backoff. - 'data-loss': Unrecoverable data loss or corruption. - 'unauthenticated': The request does not have valid authentication credentials for the operation.

Подпись:

export declare type FirestoreErrorCode = 'cancelled' | 'unknown' | 'invalid-argument' | 'deadline-exceeded' | 'not-found' | 'already-exists' | 'permission-denied' | 'resource-exhausted' | 'failed-precondition' | 'aborted' | 'out-of-range' | 'unimplemented' | 'internal' | 'unavailable' | 'data-loss' | 'unauthenticated';

FirestoreLocalCache

Union type from all supported SDK cache layer.

Подпись:

export declare type FirestoreLocalCache = MemoryLocalCache | PersistentLocalCache;

ListenSource

Describe the source a query listens to.

Set to default to listen to both cache and server changes. Set to cache to listen to changes in cache only.

Подпись:

export declare type ListenSource = 'default' | 'cache';

MemoryGarbageCollector

Union type from all support garbage collectors for memory local cache.

Подпись:

export declare type MemoryGarbageCollector = MemoryEagerGarbageCollector | MemoryLruGarbageCollector;

NestedUpdateFields

For each field (eg 'bar'), find all nested keys (eg { 'bar.baz': T1, 'bar.qux': T2 } ). Intersect them together to make a single map containing all possible keys that are all marked as optional

Подпись:

export declare type NestedUpdateFields<T extends Record<string, unknown>> = UnionToIntersection<{
    [K in keyof T & string]: ChildUpdateFields<K, T[K]>;
}[keyof T & string]>;

OrderByDirection

The direction of a orderBy() clause is specified as 'desc' or 'asc' (descending or ascending).

Подпись:

export declare type OrderByDirection = 'desc' | 'asc';

PartialWithFieldValue

Similar to TypeScript's Partial<T> , but allows nested fields to be omitted and FieldValues to be passed in as property values.

Подпись:

export declare type PartialWithFieldValue<T> = Partial<T> | (T extends Primitive ? T : T extends {} ? {
    [K in keyof T]?: PartialWithFieldValue<T[K]> | FieldValue;
} : never);

PersistentTabManager

A union of all available tab managers.

Подпись:

export declare type PersistentTabManager = PersistentSingleTabManager | PersistentMultipleTabManager;

Примитивный

Примитивные типы.

Подпись:

export declare type Primitive = string | number | boolean | undefined | null;

QueryConstraintType

Describes the different query constraints available in this SDK.

Подпись:

export declare type QueryConstraintType = 'where' | 'orderBy' | 'limit' | 'limitToLast' | 'startAt' | 'startAfter' | 'endAt' | 'endBefore';

QueryFilterConstraint

QueryFilterConstraint is a helper union type that represents QueryFieldFilterConstraint and QueryCompositeFilterConstraint .

Подпись:

export declare type QueryFilterConstraint = QueryFieldFilterConstraint | QueryCompositeFilterConstraint;

QueryNonFilterConstraint

QueryNonFilterConstraint is a helper union type that represents QueryConstraints which are used to narrow or order the set of documents, but that do not explicitly filter on a document field. QueryNonFilterConstraint s are created by invoking orderBy() , startAt() , startAfter() , endBefore() , endAt() , limit() or limitToLast() and can then be passed to query() to create a new query instance that also contains the QueryConstraint .

Подпись:

export declare type QueryNonFilterConstraint = QueryOrderByConstraint | QueryLimitConstraint | QueryStartAtConstraint | QueryEndAtConstraint;

SetOptions

An options object that configures the behavior of setDoc() , and calls. These calls can be configured to perform granular merges instead of overwriting the target documents in their entirety by providing a SetOptions with merge: true .

Подпись:

export declare type SetOptions = {
    readonly merge?: boolean;
} | {
    readonly mergeFields?: Array<string | FieldPath>;
};

Таскстате

Represents the state of bundle loading tasks.

Both 'Error' and 'Success' are sinking state: task will abort or complete and there will be no more updates after they are reported.

Подпись:

export declare type TaskState = 'Error' | 'Running' | 'Success';

UnionToIntersection

Given a union type U = T1 | T2 | ... , returns an intersected type (T1 & T2 & ...) .

Uses distributive conditional types and inference from conditional types. This works because multiple candidates for the same type variable in contra-variant positions causes an intersection type to be inferred. https://www.typescriptlang.org/docs/handbook/advanced-types.html#type-inference-in-conditional-types https://stackoverflow.com/questions/50374908/transform-union-type-to-intersection -тип

Подпись:

export declare type UnionToIntersection<U> = (U extends unknown ? (k: U) => void : never) extends (k: infer I) => void ? I : never;

UpdateData

Update data (for use with updateDoc() ) that consists of field paths (eg 'foo' or 'foo.baz') mapped to values. Fields that contain dots reference nested fields within the document. FieldValues can be passed in as property values.

Подпись:

export declare type UpdateData<T> = T extends Primitive ? T : T extends {} ? {
    [K in keyof T]?: UpdateData<T[K]> | FieldValue;
} & NestedUpdateFields<T> : Partial<T>;

WhereFilterOp

Filter conditions in a where() clause are specified using the strings '&lt;', '&lt;=', '==', '!=', '&gt;=', '&gt;', 'array-contains', 'in', 'array-contains-any', and 'not-in'.

Подпись:

export declare type WhereFilterOp = '<' | '<=' | '==' | '!=' | '>=' | '>' | 'array-contains' | 'in' | 'array-contains-any' | 'not-in';

WithFieldValue

Allows FieldValues to be passed in as a property value while maintaining type safety.

Подпись:

export declare type WithFieldValue<T> = T | (T extends Primitive ? T : T extends {} ? {
    [K in keyof T]: WithFieldValue<T[K]> | FieldValue;
} : never);