@firebase/firestore/lite

Функции

Классы

Интерфейсы

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

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

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 предоставленного приложения.

инициализироватьFirestore (приложение, настройки)

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

Подпись:

export declare function initializeFirestore(app: FirebaseApp, settings: Settings): Firestore;

Параметры

Возврат:

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

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

инициализироватьFirestore (приложение, настройки, идентификатор базы данных)

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

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

Подпись:

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

Параметры

Возврат:

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

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

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

коллекция (firestore, путь, pathSegments)

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

Подпись:

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

Параметры

Возврат:

КоллекцияСправочник < Данные документа , Данные документа >

Экземпляр CollectionReference .

Исключения

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

CollectionGroup(Firestore, CollectionId)

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

Подпись:

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

Параметры

Возврат:

Запрос < Данные документа , Данные документа >

Созданный Query .

ConnectFirestoreEmulator (firestore, хост, порт, параметры)

Измените этот экземпляр для связи с эмулятором Cloud Firestore.

Подпись:

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

Параметры

Возврат:

пустота

Док (Firestore, Pathsegments)

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

Подпись:

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

Параметры

Возврат:

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

Экземпляр DocumentReference .

Исключения

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

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 возвращается сюда. В противном случае, если транзакция не удалась, возвращается отклоненное обещание с соответствующей ошибкой сбоя.

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

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

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

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

Подпись:

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

Параметры

Возврат:

Обещание <Void>

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

writebatch (Firestore)

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

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

Подпись:

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;

Возврат:

ПолеValue

documentId ()

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

Подпись:

export declare function documentId(): FieldPath;

Возврат:

ФилдПат

getFirestore ()

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

Подпись:

export declare function getFirestore(): Firestore;

Возврат:

Firestore

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

серверTimestamp()

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

Подпись:

export declare function serverTimestamp(): FieldValue;

Возврат:

ПолеValue

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

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

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

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

Подпись:

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

Параметры

Возврат:

Firestore

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

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

ArrayRemove (элементы)

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

Подпись:

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

Параметры

Возврат:

ПолеValue

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

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

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

Подпись:

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

Параметры

Возврат:

ПолеValue

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

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

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

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

Подпись:

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

Параметры

Возврат:

Совокупное поле <номер | 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, значение)

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

Подпись:

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

Параметры

Возврат:

QueryfieldfilterConstraint

Созданный QueryfieldfilterConstraint .

функция (Field Values, ...)

Endat (FieldValues)

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

Подпись:

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

Параметры

Возврат:

QueryEndatConstraint

QueryEndatConstraint , чтобы передать query()

Конец перед (FieldValues)

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

Подпись:

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

Параметры

Возврат:

QueryEndatConstraint

QueryEndatConstraint , чтобы передать query()

startafter (FieldValues)

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

Подпись:

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

Параметры

Возврат:

QueryStartatConstraint

QueryStartatConstraint , чтобы передать query()

Startat (FieldValues)

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

Подпись:

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

Параметры

Возврат:

QueryStartatConstraint

QueryStartatConstraint , чтобы передать query() .

функция (слева, ...)

совокупное полевое (слева, справа)

Сравнивает два «совокупного поля `Примеры равенства.

Подпись:

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

Параметры

Возврат:

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

Aggregatequerysnapshotequal (слева, справа)

Сравнивает два экземпляра AggregateQuerySnapshot для равенства.

Два экземпляра AggregateQuerySnapshot считаются «равными», если они имеют базовые запросы, которые сравнивают равные, и одни и те же данные.

Подпись:

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

Параметры

Возврат:

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

true , если объекты «равны», как определено выше, или false .

Queryequal (слева, справа)

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

Подпись:

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

Параметры

Возврат:

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

Верно, если ссылки указывают на то же место в той же базе данных Firestore.

Рефекция (слева, справа)

Возвращает True, если предоставленные ссылки равны.

Подпись:

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

Параметры

Возврат:

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

Верно, если ссылки указывают на то же место в той же базе данных Firestore.

SnapshoteQual (слева, справа)

Возвращает True, если предоставленные снимки равны.

Подпись:

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

Параметры

Возврат:

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

Правда, если снимки равны.

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

предел (предел)

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

Подпись:

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

Параметры

Возврат:

QueryLimitConstraint

Созданный QueryLimitConstraint .

limitToLast(ограничение)

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

Вы должны указать как минимум один пункт orderBy для запросов limitToLast , в противном случае исключение будет брошено во время выполнения.

Подпись:

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

Параметры

Возврат:

QueryLimitConstraint

Созданный QueryLimitConstraint .

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

setloglevel (loglevel)

Устанавливает условно -известные журналы Firestore (отладка, ошибка или молчание).

Подпись:

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

Параметры

Возврат:

пустота

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

Приращение (n)

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

Если либо операнд, либо текущее значение поля использует точность плавающей точки, вся арифметика следует за семантикой IEEE 754. Если оба значения являются целыми числами, значения за пределами диапазона безопасных номеров JavaScript ( Number.MIN_SAFE_INTEGER to Number.MAX_SAFE_INTEGER ) также подвержены потере точности. Кроме того, после обработки бэкэнд Firestore все целочисленные операции ограничены между -2^63 и 2^63-1.

Если текущее значение поля не имеет number типа , или если поля еще не существует, преобразование устанавливает поле на заданное значение.

Подпись:

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

Параметры

Возврат:

ПолеValue

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

функция (запрос, ...)

Getaggregate (запрос, агрегаты)

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

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

Подпись:

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

Параметры

Возврат:

Обещание < aggregatequerysnapshot <Aggergatespoctype, appmodeltype, dbmodeltype >>

Пример

const aggregateSnapshot = await getAggregate(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;

GetCount (запрос)

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

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

Подпись:

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

Параметры

Возврат:

Обещание < aggregatequerysnapshot <{count: Aggregatefield <число>; }, AppModelType, dbmodeltype >>

Обещание, которое будет решено с графом; Подсчет может быть извлечен из snapshot.data().count , где snapshot находится AggregateQuerySnapshot , которому разрешается возвращаемое обещание.

getdocs (запрос)

Выполняет запрос и возвращает результаты как Querysnapshot .

Все запросы выполняются непосредственно сервером, даже если запрос был ранее выполнен. Недавние модификации отражаются только в полученных результатах, только если они уже применялись бэкэнд. Если клиент не в автономном режиме, операция не выполняется. Чтобы увидеть ранее кэшированный результат и локальные модификации, используйте полный SDK Firestore.

Подпись:

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

Параметры

Возврат:

Обещание < Querysnapshot <Appmodeltype, dbmodeltype >>

Обещание, которое будет разрешено с результатами запроса.

запрос (запрос, композитныйфильтер, QueryConstraints)

Создает новый неизменяемый экземпляр Query , который расширяется и включает дополнительные ограничения запроса.

Подпись:

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

Параметры

Возврат:

Запрос <AppModelType, DbModelType>

Исключения

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

запрос (запрос, queryConstraints)

Создает новый неизменяемый экземпляр Query , который расширяется и включает дополнительные ограничения запроса.

Подпись:

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

Параметры

Возврат:

Запрос <AppModelType, DbModelType>

Исключения

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

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

и (QueryConstraints)

Создает новый QueryCompositeFilterConstraint , который является соединением заданных ограничений фильтра. Фильтр соединения включает документ, если он удовлетворяет всем данным фильтрам.

Подпись:

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

Параметры

Возврат:

QueryCompositeFilterConstraint

Недавно созданный QueryCompositeFilterConstraint .

или (QueryConstraints)

Создает новый QueryCompositeFilterConstraint , который является дизъюнкцией заданных ограничений фильтра. Фильтр дизъюнкции включает в себя документ, если он удовлетворяет какой -либо из данных фильтров.

Подпись:

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

Параметры

Возврат:

QueryCompositeFilterConstraint

Недавно созданный QueryCompositeFilterConstraint .

функция (ссылка, ...)

AddDoc (ссылка, данные)

Добавьте новый документ в указанный CollectionReference с данными данных, автоматически присваивая ему идентификатор документа.

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

Подпись:

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

Параметры

Возврат:

Обещание < documentReference <Appmodeltype, dbmodeltype >>

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

Исключения

Ошибка - если предоставленный вход не является действительным документом Firestore.

Сбор (ссылка, путь, пути)

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

Подпись:

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

Параметры

Возврат:

CollectionReference < DocumentData , DocumentData >

Экземпляр CollectionReference .

Исключения

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

Сбор (ссылка, путь, пути)

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

Подпись:

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

Параметры

Возврат:

CollectionReference < DocumentData , DocumentData >

Экземпляр CollectionReference .

Исключения

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

deletedoc (ссылка)

Удаляет документ, упомянутый указанным DocumentReference .

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

Подпись:

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

Параметры

Возврат:

Обещание <Void>

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

Док (ссылка, путь, пути)

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

Подпись:

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

Параметры

Возврат:

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

Экземпляр DocumentReference .

Исключения

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

Док (ссылка, путь, пути)

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

Подпись:

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

Параметры

Возврат:

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

Экземпляр DocumentReference .

Исключения

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

getdoc (ссылка)

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

Все документы непосредственно извлекаются с сервера, даже если документ был ранее прочитал или изменен. Недавние модификации отражаются только в извлеченных DocumentSnapshot . Если клиент не в автономном режиме, чтение не удается. Если вы хотите использовать кэширование или видите локальные модификации, используйте полный SDK Firestore.

Подпись:

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

Параметры

Возврат:

Обещание < документынапшот <Appmodeltype, dbmodeltype >>

Обещание разрешено с помощью DocumentSnapshot , содержащего текущее содержимое документа.

setDoc (ссылка, данные)

Письмо в документ, упомянутый указанным DocumentReference . Если документ еще не существует, он будет создан.

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

Подпись:

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

Параметры

Возврат:

Обещание <Void>

Promise разрешено, как только данные были успешно записаны на бэкэнд.

Исключения

Ошибка - если предоставленный вход не является действительным документом Firestore.

SetDoc (ссылка, данные, параметры)

Письмо в документ, упомянутый указанным DocumentReference . Если документ еще не существует, он будет создан. Если вы предоставляете merge или mergeFields Предоставленные данные могут быть объединены в существующий документ.

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

Подпись:

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

Параметры

Возврат:

Обещание <Void>

Promise разрешено, как только данные были успешно записаны на бэкэнд.

Исключения

Ошибка - если предоставленный вход не является действительным документом Firestore.

updatedoc (ссылка, данные)

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

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

Подпись:

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

Параметры

Возврат:

Обещание <Void>

Promise разрешено, как только данные были успешно записаны на бэкэнд.

Исключения

Ошибка - если предоставленный вход не является допустимым данными Firestore.

Updatedoc (ссылка, поле, значение, MoreFieldSandValues)

Поля обновлений В документе, упомянутом указанным DocumentReference , обновление не удастся, если будет применено к документу, который не существует.

Вложенные поля могут быть обновлены, предоставляя DOT-разделенные строки полевых путей или предоставив объекты FieldPath .

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

Подпись:

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

Параметры

Возврат:

Обещание <Void>

Promise разрешено, как только данные были успешно записаны на бэкэнд.

Исключения

Ошибка - если предоставленный вход не является допустимым данными Firestore.

функция (снимки, ...)

Endat (снимок)

Создает запрос QueryEndatConstraint , который изменяет результат, установленную на завершение в предоставленном документе (включительно). Конечная позиция относительно порядка запроса. Документ должен содержать все поля, представленные в заказе запроса.

Подпись:

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

Параметры

Возврат:

QueryEndatConstraint

QueryEndatConstraint , чтобы передать query()

Endfefore (Snapshot)

Создает запрос QueryEndatConstraint , который изменяет набор результатов, чтобы закончить перед предоставленным документом (эксклюзивным). Конечная позиция относительно порядка запроса. Документ должен содержать все поля, представленные в заказе запроса.

Подпись:

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

Параметры

Возврат:

QueryEndatConstraint

QueryEndatConstraint , чтобы передать query()

startafter (снимок)

Создает QueryStartatConstraint , которая изменяет набор результатов для начала после предоставленного документа (эксклюзив). Начальная позиция относится к порядку запроса. Документ должен содержать все поля, представленные в заказе запроса.

Подпись:

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

Параметры

Возврат:

QueryStartatConstraint

QueryStartatConstraint , чтобы передать query()

Startat (снимок)

Создает QueryStartatConstraint , которая изменяет набор результатов для начала в предоставленном документе (включительно). Начальная позиция относится к порядку запроса. Документ должен содержать все поля, представленные в orderBy этого запроса.

Подпись:

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

Параметры

Возврат:

QueryStartatConstraint

QueryStartatConstraint , чтобы передать query() .

Addprefixtokeys

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

Подпись:

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

Совокупныйфилдтип

Союз всех типов AggregateField , которые поддерживаются Firestore.

Подпись:

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

АгрегатеСпецДанные

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

Подпись:

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

Агрегаттип

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

Подпись:

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

Childupdatefields

Помощник для расчета вложенных полей для данного типа T1. Это необходимо для распространения типов союзов, таких как undefined | {...} (случается для дополнительных реквизитов) или {a: A} | {b: B} .

В этом варианте использования V используется для распределения типов союзов T[K] в Record , поскольку T[K] оценивается как выражение и не распределяется.

См

Подпись:

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

FirestoreErrorCode

Набор кодов статуса Firestore. Коды одинаковы на тех, которые выявляются GRPC здесь: https://github.com/grpc/grpc/blob/master/doc/statuscodes.md

Возможные значения: - «Отмена»: операция была отменена (обычно вызывающим абонент). - «Неизвестно»: неизвестная ошибка или ошибка из другого домена ошибки. - 'Invalid-Argument': клиент указал неверный аргумент. Обратите внимание, что это отличается от «неудачного назначения». «Недостаточный аргумент» указывает на аргументы, которые являются проблематичными независимо от состояния системы (например, неверное имя поля). - «Срок срока»: срок действия срока истек до завершения операции. Для операций, которые изменяют состояние системы, эта ошибка может быть возвращена, даже если операция успешно завершилась. Например, успешный ответ с сервера мог быть отложено достаточно долго, чтобы срок действия истекала. - «Неудачный»: какой-то запрошенный документ не был найден. - «Уже существует»: какой-то документ, который мы пытались создать, уже существует. - «Разрушение разрешения»: у вызывающего абонента нет разрешения на выполнение указанной операции. -«Ресурс-эксплуатированный»: какой-то ресурс был исчерпан, возможно, квота для каждого пользователя, или, возможно, вся файловая система вышла из космоса. - «Неудачное назначение»: операция была отклонена, потому что система не находится в состоянии, необходимого для выполнения операции. - «Прерванная»: операция была прервана, как правило, из-за вопроса о параллелизме, такой как транзакции, прервания и т. Д. - «Неограниченное»: операция не реализована или не поддерживается/включена. - «Внутренние»: внутренние ошибки. Означает, что некоторые инварианты, ожидаемые базовой системой, были нарушены. Если вы видите одну из этих ошибок, что -то очень сломано. - «недоступен»: в настоящее время услуга недоступна. Это, скорее всего, переходное состояние и может быть исправлено путем повторения с отбором. - «Утолп данных»: невозможно потери или коррупция данных. - «Неавтотифицированный»: запрос не имеет действительных учетных данных аутентификации для операции.

Подпись:

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

Вложенные

Для каждого поля (например, «Бар») найдите все вложенные ключи (например, { 'bar.baz': t1, 'bar.qux': t2 } ). Пересечь их вместе, чтобы сделать одну карту, содержащую все возможные ключи, которые отмечены как необязательные

Подпись:

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

Порядок работы

Направление пункта OrderBy () указывается как «DESC» или «ASC» (нисходящее или восходящее).

Подпись:

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

PartialwithfieldValue

Подобно Partial<T> , но позволяет вложенным полям быть опущенными, а в качестве значений свойств в качестве значений свойств.

Подпись:

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

Примитивный

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

Подпись:

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

QueryConstraintType

Описывает различные ограничения запросов, доступные в этом SDK.

Подпись:

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

Ограничение QueryFilterConstraint

QueryFilterConstraint - это помощник, который представляет QueryfieldFilterConstraint и QueryCompositeFilterConstraint .

Подпись:

export declare type QueryFilterConstraint = QueryFieldFilterConstraint | QueryCompositeFilterConstraint;

QueryNonFilterConstraint

QueryNonFilterConstraint - это вспомогательный тип союза, который представляет QueryConstraints, которые используются для сужения или упорядочения набора документов, но которые явно не фильтруют в поле документа. QueryNonFilterConstraint s созданы путем вызова orderby () , начатьВ() , стартПосле() , КонецПеред() , endat () , Limit () или Limittolast () , а затем может быть передано в Query () для создания нового экземпляра запроса, который также содержит QueryConstraint .

Подпись:

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

Установить параметры

Объект параметров, который настраивает поведение setDoc () и звонки. Эти вызовы могут быть настроены для выполнения гранулированных слияний вместо того, чтобы полностью перезаписать целевые документы, предоставляя SetOptions merge: true .

Подпись:

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

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 -тип

Подпись:

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

Обновляется

Обновление данных (для использования с помощью updateC () ), который состоит из полевых путей (например, «foo» или «foo.baz»), отображаемых с значениями. Поля, которые содержат точки, ссылаются на вложенные поля в документе. Field Values ​​может быть передано в качестве значений свойств.

Подпись:

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

Гдефильтер

Условия фильтра в пункте where () указаны с использованием строк «& lt; ',' & lt; = ',' == ','! , 'in', 'Array-Contains-Any' и «Not-in».

Подпись:

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

Сфилдвейл

Позволяет проходить в качестве значения свойства в качестве значения свойства при сохранении безопасности типа.

Подпись:

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