@firebase/firestore

Функции

Классы

Интерфейсы

Переменные

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

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

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

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

Подпись:

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

Параметры

Возврат:

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

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

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

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

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

Подпись:

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

Параметры

Возврат:

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

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

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

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

Подпись:

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

Параметры

Возврат:

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

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

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

ClearIndExedDbperSistence (Firestore)

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

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

Подпись:

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

Параметры

Возврат:

Обещание<void>

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

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

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

Подпись:

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

Параметры

Возврат:

CollectionReference < DocumentData , DocumentData >

Экземпляр CollectionReference .

Исключения

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

CollectionGroup (Firestore, CollectionId)

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

Подпись:

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

Параметры

Возврат:

Запрос < 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;

Параметры

Возврат:

пустота

Disablenetwork (Firestore)

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

Подпись:

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

Параметры

Возврат:

Обещание<void>

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

Док (Firestore, Pathsegments)

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

Подпись:

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

Параметры

Возврат:

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>;

Параметры

Возврат:

Обещание<void>

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

EnableMultItAbindExedDbperSistence (Firestore)

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

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

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

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

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

Подпись:

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

Параметры

Возврат:

Обещание<void>

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

EnablenetWork (Firestore)

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

Подпись:

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

Параметры

Возврат:

Обещание<void>

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

getPersistEntCacheindexmanager (Firestore)

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

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

Подпись:

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

Параметры

Возврат:

PersistentCacheindexmanager | нулевой

LoadBundle (Firestore, Bundledata)

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

Подпись:

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

Параметры

Возврат:

LoadBundletask

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

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

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

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

Подпись:

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

Параметры

Возврат:

Обещание < 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;

Параметры

Возврат:

Отписаться

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

onsnapshotsinsync (Firestore, Onsync)

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

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

Подпись:

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

Параметры

Возврат:

Отписаться

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

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>;

Параметры

Возврат:

Обещание <T>

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

SetIndexConfiguration (Firestore, Configuration)

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

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

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

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

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

Подпись:

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

Параметры

Возврат:

Обещание<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>;

Параметры

Возврат:

Обещание<void>

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

Исключения

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

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

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

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

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

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

Подпись:

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

Параметры

Возврат:

Обещание<void>

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

WaitForpendingWrites (Firestore)

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

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

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

Подпись:

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

Параметры

Возврат:

Обещание<void>

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

writebatch (Firestore)

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

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

Подпись:

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

Параметры

Возврат:

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;

Параметры

Возврат:

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;

Параметры

Возврат:

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;

Параметры

Возврат:

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;

Параметры

Возврат:

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;

Параметры

Возврат:

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;

Параметры

Возврат:

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;

Параметры

Возврат:

пустота

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;

Параметры

Возврат:

пустота

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;

Параметры

Возврат:

пустота

function(left, ...)

aggregateFieldEqual(left, right)

Compares two 'AggregateField ` instances for equality.

Подпись:

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

Параметры

Возврат:

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

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;

Параметры

Возврат:

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

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;

Параметры

Возврат:

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

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;

Параметры

Возврат:

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

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;

Параметры

Возврат:

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

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;

Параметры

Возврат:

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;

Параметры

Возврат:

QueryLimitConstraint

The created QueryLimitConstraint .

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

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

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

Подпись:

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

Параметры

Возврат:

пустота

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 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>>;

Параметры

Возврат:

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>>;

Параметры

Возврат:

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>>;

Параметры

Возврат:

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>>;

Параметры

Возврат:

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>>;

Параметры

Возврат:

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;

Параметры

Возврат:

Отписаться

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;

Параметры

Возврат:

Отписаться

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;

Параметры

Возврат:

Отписаться

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;

Параметры

Возврат:

Отписаться

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>

Исключения

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>

Исключения

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;

Параметры

Возврат:

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;

Параметры

Возврат:

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>>;

Параметры

Возврат:

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 < 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>;

Параметры

Возврат:

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>;

Параметры

Возврат:

Обещание<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>;

Параметры

Возврат:

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 < 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>>;

Параметры

Возврат:

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>>;

Параметры

Возврат:

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>>;

Параметры

Возврат:

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;

Параметры

Возврат:

Отписаться

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;

Параметры

Возврат:

Отписаться

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;

Параметры

Возврат:

Отписаться

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;

Параметры

Возврат:

Отписаться

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>;

Параметры

Возврат:

Обещание<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>;

Параметры

Возврат:

Обещание<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>;

Параметры

Возврат:

Обещание<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>;

Параметры

Возврат:

Обещание<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;

Параметры

Возврат:

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;

Параметры

Возврат:

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;

Параметры

Возврат:

PersistentLocalCache

persistentSingleTabManager(settings)

Creates an instance of PersistentSingleTabManager .

Подпись:

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

Параметры

Возврат:

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;

Параметры

Возврат:

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;

Параметры

Возврат:

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;

Параметры

Возврат:

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;

Параметры

Возврат:

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;

Параметры

Возврат:

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;