@firebase/firestore

Funkcje

Zajęcia

Interfejsy

Zmienne

Wpisz aliasy

funkcja (aplikacja, ...)

getfirestore (aplikacja)

Zwraca istniejącą domyślną instancję Firestore , która jest powiązana z dostarczonym FireBaseApp . Jeśli nie istnieje żadna instancja, inicjuje nową instancję z ustawieniami domyślnymi.

Podpis:

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

Parametry

Zwroty:

Firestore

Domyślna instancja Firestore w dostarczonej aplikacji.

getfirestore (app, batabaseID)

Ten interfejs API jest dostarczany jako podgląd dla programistów i może się zmienić na podstawie otrzymywanych informacji zwrotnych. Nie używaj tego interfejsu API w środowisku produkcyjnym.

Zwraca istniejącą nazwaną instancję Firestore , która jest powiązana z dostarczonym FireBaseApp . Jeśli nie istnieje żadna instancja, inicjuje nową instancję z ustawieniami domyślnymi.

Podpis:

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

Parametry

Zwroty:

Firestore

Nazwana instancja Firestore dostarczonej aplikacji.

initizeFirestore (App, Ustawienia, DatabaseID)

Inicjuje nową instancję Firestore z dostarczonymi ustawieniami. Można wywołać tylko przed jakąkolwiek inną funkcją, w tym getfirestore () . Jeśli ustawienia niestandardowe są puste, ta funkcja jest równoważna wywoływaniu getfirestore () .

Podpis:

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

Parametry

Zwroty:

Firestore

Nowo zainicjowana instancja Firestore .

funkcja (Firestore, ...)

ClearIndexedDBPersistence (Firestore)

Usuwa trwałe przechowywanie. Obejmuje to oczekujące zapisy i dokumenty buforowane.

Należy wywołać, gdy instancja Firestore nie jest uruchamiana (po zakończeniu aplikacji lub po pierwszej inicjalizacji aplikacji). Po uruchomieniu ta funkcja musi być wywołana przed innymi funkcjami (innymi niż initizefirestore () lub getfirestore () )). Jeśli instancja Firestore nadal działa, obietnica zostanie odrzucona wraz z kodem błędu failed-precondition .

Podpis:

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

Parametry

Zwroty:

Obiecaj <Void>

Promise , która jest rozwiązana po wyczyszczeniu trwałego przechowywania. W przeciwnym razie obietnica jest odrzucana z błędem.

Kolekcja (Firestore, ścieżka, Pathsegments)

Otrzymuje instancję CollectionReference , która odnosi się do kolekcji na określonej bezwzględnej ścieżce.

Podpis:

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

Parametry

Zwroty:

CollectionReference < DocumentData , DocumentData >

Instancja CollectionReference .

Wyjątki

Jeśli ostatnia ścieżka ma parzystą liczbę segmentów i nie wskazuje na kolekcję.

Kolekcja Grupa (Firestore, CollectionId)

Tworzy i zwraca nową instancję Query , która zawiera wszystkie dokumenty w bazie collectionId zawarty .

Podpis:

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

Parametry

Zwroty:

Zapytanie < DocumentData , DocumentData >

Utworzone Query .

ConnectFirestoreEmulator (Firestore, host, port, opcje)

Zmodyfikuj tę instancję, aby komunikować się z emulatorem Cloud Firestore.

Podpis:

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

Parametry

Zwroty:

próżnia

niepełnosprawne (Firestore)

Wyłącza użycie sieci dla tego przypadku. Można go ponownie włączyć za pośrednictwem enableNetWork () . Podczas gdy sieć jest wyłączona, wszelkie wywołania słuchaczy migawek, połączenia getDoc() lub getDocs() zwracają wyniki z pamięci podręcznej, a wszelkie operacje zapisu zostaną ustawione w kolejce do momentu przywrócenia sieci.

Podpis:

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

Parametry

Zwroty:

Obiecaj <Void>

Promise , która zostanie rozwiązana po wyłączeniu sieci.

Doc (Firestore, Path, Pathsegments)

Otrzymuje instancję DocumentReference , która odnosi się do dokumentu na określonej ścieżce bezwzględnej.

Podpis:

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

Parametry

Zwroty:

Odnośnik do dokumentu < DocumentData , DocumentData >

Instancja DocumentReference .

Wyjątki

Jeśli ostatnia ścieżka ma nieparzystą liczbę segmentów i nie wskazuje na dokument.

EnableIndexedDBPersistence (Firestore, Tristencesettings)

Ta funkcja zostanie usunięta w przyszłości głównej wersji. Zamiast tego ustaw FirestoreSettings.localCache na instancję PersistentLocalCache , aby włączyć pamięć podręczną indexEdDB. Wywołanie tej funkcji, gdy FirestoreSettings.localCache jest już określony, rzuci wyjątek.

Jeśli to możliwe, próby włączenia trwałego przechowywania.

W przypadku awarii enableIndexedDbPersistence() odrzuci obietnicę lub rzuci wyjątek. Istnieje kilka powodów, dla których może to zawieść, co może być zidentyfikowane przez code błędu.

* Niepowodzenie Precondition: Aplikacja jest już otwarta w innej zakładce przeglądarki. * Niewystępowane: przeglądarka jest niezgodna z implementacją trwałości offline.

Zauważ, że nawet po awarii instancja Firestore pozostanie użyteczna, jednak trwałość offline będzie wyłączona.

Trwałości nie można użyć w środowisku Node.js.

Podpis:

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

Parametry

Zwroty:

Obiecaj <Void>

Promise , która reprezentuje skutecznie umożliwiającą trwałe przechowywanie.

EnablemultitaBindexedDBPersistence (Firestore)

Ta funkcja zostanie usunięta w przyszłości głównej wersji. Zamiast tego ustaw FirestoreSettings.localCache na instancję PersistentLocalCache , aby włączyć pamięć podręczną indexEdDB. Wywołanie tej funkcji, gdy FirestoreSettings.localCache jest już określony, rzuci wyjątek.

Jeśli to możliwe, próby włączenia trwałego przechowywania wielu Tab. Jeśli włączone we wszystkich kartach, wszystkie operacje udostępniają dostęp do lokalnej trwałości, w tym udostępnione wykonywanie zapytania i aktualizacje dokumentów lokalnych kompensowanych opóźnień we wszystkich podłączonych instancjach.

W przypadku awarii enableMultiTabIndexedDbPersistence() odrzuci obietnicę lub rzuci wyjątek. Istnieje kilka powodów, dla których może to zawieść, co może być zidentyfikowane przez code błędu.

* Niepowodzenie: aplikacja jest już otwarta w innej zakładce przeglądarki, a Multi-Tab nie jest włączona. * Niewystępowane: przeglądarka jest niezgodna z implementacją trwałości offline.

Zauważ, że nawet po awarii instancja Firestore pozostanie użyteczna, jednak trwałość offline będzie wyłączona.

Podpis:

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

Parametry

Zwroty:

Obiecaj <Void>

Promise , która reprezentuje skutecznie umożliwiającą trwałe przechowywanie.

EnableNetwork (Firestore)

Ponowne uwzględnienie korzystania z sieci dla tej instancji Firestore po wcześniejszym wezwaniu do DisableNetwork () .

Podpis:

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

Parametry

Zwroty:

Obiecaj <Void>

Promise , która zostanie rozwiązana po włączeniu sieci.

getPersistentCacheIndexManager (Firestore)

Zwraca menedżer indeksu uporczych wykorzystywany przez podany obiekt Firestore .

Instancja PersistentCacheIndexManager lub null , jeśli nie jest używana lokalna trwałe przechowywanie.

Podpis:

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

Parametry

Zwroty:

TristentCacheIndexManager | zero

Loadbundle (Firestore, Bundledata)

Ładuje pakiet Firestore do lokalnej pamięci podręcznej.

Podpis:

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

Parametry

Zwroty:

Loadbundletask

Obiekt LoadBundleTask , który powiadamia dzwoniących z aktualizacjami postępu oraz zdarzeniami ukończenia lub błędu. Może być używany jako Promise<LoadBundleTaskProgress> .

NamedQuery (Firestore, nazwa)

Czyta zapytanie Firestore z lokalnej pamięci podręcznej, zidentyfikowane pod daną nazwą.

Nazwane zapytania są pakowane w pakiety po stronie serwera (wraz z wynikowymi dokumentami) i załadowane do lokalnej pamięci podręcznej za pomocą loadBundle . Po lokalnej pamięci podręcznej użyj tej metody, aby wyodrębnić zapytanie według nazwy.

Podpis:

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

Parametry

Zwroty:

Obiecaj < zapytanie | null>

Promise , która jest rozwiązana z zapytaniem lub null .

onsnapshotssync (Firestore, Observer)

Dołącza słuchacza do zdarzenia migawek w synchronizacji. Zdarzenie migawek-synchronizacji wskazuje, że wszyscy słuchacze danej zmiany zwolnili, nawet jeśli jedna zmiana generowana przez serwer wpływa na wielu słuchaczy.

Uwaga: zdarzenie migawek w synchronizacji wskazuje tylko, że słuchacze są zsynchronizowane ze sobą, ale nie odnosi się do tego, czy migawki są zsynchronizowane z serwerem. Użyj SnapshotMetAdata w poszczególnych słuchaczy, aby ustalić, czy migawka pochodzi z pamięci podręcznej lub serwera.

Podpis:

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

Parametry

Zwroty:

Zrezygnuj z subskrypcji

Funkcja rezygnacji z subskrypcji, którą można wywołać w celu anulowania słuchacza migawki.

onsnapshotssync (Firestore, onsync)

Dołącza słuchacza do zdarzenia migawek w synchronizacji. Zdarzenie migawek-synchronizacji wskazuje, że wszyscy słuchacze danej zmiany zwolnili, nawet jeśli jedna zmiana generowana przez serwer wpływa na wielu słuchaczy.

Uwaga: zdarzenie migawek w synchronizacji wskazuje tylko, że słuchacze są zsynchronizowane ze sobą, ale nie odnosi się do tego, czy migawki są zsynchronizowane z serwerem. Użyj SnapshotMetadata w poszczególnych słuchaczy, aby ustalić, czy migawka pochodzi z pamięci podręcznej lub serwera.

Podpis:

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

Parametry

Zwroty:

Zrezygnuj z subskrypcji

Funkcja rezygnacji z subskrypcji, którą można wywołać w celu anulowania słuchacza migawki.

Runtransaction (Firestore, aktualizacja funkcja, opcje)

Wykonuje daną updateFunction , a następnie próbuje popełnić zmiany zastosowane w transakcji. Jeśli jakikolwiek dokument odczytany w ramach transakcji, Cloud Firestore odpowiada updateFunction . Jeśli nie popełni się po 5 próbach, transakcja się nie powiedzie.

Maksymalna liczba zapisów dozwolonych w jednej transakcji wynosi 500.

Podpis:

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

Parametry

Zwroty:

Obietnica <t>

Jeśli transakcja zakończyła się pomyślnie lub została wyraźnie przerwana ( updateFunction zwróciła nieudaną obietnicę), obietnica zwrócona przez updateFunction zwracany tutaj. W przeciwnym razie, jeśli transakcja się nie powiodła, zwracana jest odrzucona obietnica z odpowiednim błędem awarii.

setIndexConfiguration (Firestore, konfiguracja)

Ten interfejs API jest dostarczany jako podgląd dla programistów i może się zmienić na podstawie otrzymywanych informacji zwrotnych. Nie używaj tego interfejsu API w środowisku produkcyjnym.

Zamiast ręcznie tworzyć indeksy pamięci podręcznej, rozważ użycie enablePersistentCacheIndexAutoCreation() , aby SDK zdecydował, czy utworzyć indeksy pamięci podręcznej dla zapytań działających lokalnie.

Konfiguruje indeksowanie do wykonania lokalnego zapytania. Każda poprzednia konfiguracja indeksu jest zastąpiona. Promise rozwiązuje się po utrzymaniu konfiguracji indeksu.

Same wpisy indeksu są tworzone asynchronicznie. Możesz nadal używać zapytań wymagających indeksowania, nawet jeśli wskaźniki nie są jeszcze dostępne. Wykonywanie zapytania automatycznie zacznie się używać indeksu po napisaniu wpisów indeksu.

Indeksy są obsługiwane tylko z trwałością indexedDB. Jeśli indexEdDB nie jest włączony, jakakolwiek konfiguracja indeksu jest ignorowana.

Podpis:

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

Parametry

Zwroty:

Obiecaj <Void>

Promise , która rozwiązuje się po pomyślnym skonfigurowaniu wszystkich indeksów.

Wyjątki

Firestoreerror Jeśli format JSON jest nieprawidłowy.

SetIndexConfiguration (Firestore, Json)

Ten interfejs API jest dostarczany jako podgląd dla programistów i może się zmienić na podstawie otrzymywanych informacji zwrotnych. Nie używaj tego interfejsu API w środowisku produkcyjnym.

Zamiast ręcznie tworzyć indeksy pamięci podręcznej, rozważ użycie enablePersistentCacheIndexAutoCreation() , aby SDK zdecydował, czy utworzyć indeksy pamięci podręcznej dla zapytań działających lokalnie.

Konfiguruje indeksowanie do wykonania lokalnego zapytania. Każda poprzednia konfiguracja indeksu jest zastąpiona. Promise rozwiązuje się po utrzymaniu konfiguracji indeksu.

Same wpisy indeksu są tworzone asynchronicznie. Możesz nadal używać zapytań wymagających indeksowania, nawet jeśli wskaźniki nie są jeszcze dostępne. Wykonywanie zapytania automatycznie zacznie się używać indeksu po napisaniu wpisów indeksu.

Indeksy są obsługiwane tylko z trwałością indexedDB. Ingeluj albo enableIndexedDbPersistence() lub enableMultiTabIndexedDbPersistence() przed ustawieniem konfiguracji indeksu. Jeśli indexEdDB nie jest włączony, jakakolwiek konfiguracja indeksu jest ignorowana.

Metoda akceptuje format JSON eksportowany przez Firebase CLI ( firebase firestore:indexes ). Jeśli format JSON jest nieprawidłowy, ta metoda rzuca błąd.

Podpis:

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

Parametry

Zwroty:

Obiecaj <Void>

Promise , która rozwiązuje się po pomyślnym skonfigurowaniu wszystkich indeksów.

Wyjątki

Firestoreerror Jeśli format JSON jest nieprawidłowy.

zakończyć (Firestore)

Kończy dostarczoną instancję Firestore .

Po wywołaniu terminate() można zastosować tylko funkcję clearIndexedDbPersistence() . Każda inna funkcja rzuci FirestoreError .

Aby zrestartować po zakończeniu, utwórz nową instancję FireBasefirestore z getfirestore () .

Zakończenie nie anuluje żadnych oczekujących zapisów, a wszelkie obietnice, które oczekują na odpowiedź serwera, nie zostaną rozwiązane. Jeśli masz włączoną trwałość, następnym razem, gdy uruchomisz tę instancję, wznowią wysłanie tych zapisów na serwer.

Podpis:

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

Parametry

Zwroty:

Obiecaj <Void>

Promise , która została rozwiązana, gdy instancja została pomyślnie rozwiązana.

WaitForpendingWrites (Firestore)

Czekamy, aż wszystkie obecnie w toku zapisują, że aktywny użytkownik został potwierdzony przez backend.

Zwrócona obietnica natychmiast rozwiązuje, jeśli nie ma żadnych znakomitych zapisów. W przeciwnym razie obietnica czeka na wszystkie wcześniej wydane zapisy (w tym napisane w poprzedniej sesji aplikacji), ale nie czeka na pisze, które zostały dodane po wywołaniu funkcji. Jeśli chcesz poczekać na dodatkowe zapisy, ponownie zadzwoń do waitForPendingWrites() .

Wszelkie zaległe obietnice waitForPendingWrites() są odrzucane podczas zmian użytkowników.

Podpis:

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

Parametry

Zwroty:

Obiecaj <Void>

Promise , która rozwiązuje się, gdy wszystkie obecnie w toku zostały potwierdzone przez backend.

WriteBatch (Firestore)

Tworzy partię zapisu, używaną do wykonywania wielu zapisów jako pojedynczej operacji atomowej. Maksymalna liczba zapisów dozwolonych w jednym zapisie wynosi 500.

W przeciwieństwie do transakcji, partie zapisu są utrzymywane w trybie offline i dlatego są preferowane, gdy nie musisz kondycjonować zapisów dotyczących danych odczytu.

Podpis:

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

Parametry

Zwroty:

WriteBatch

WriteBatch , którego można użyć do atomowego wykonywania wielu zapisów.

funkcjonować()

liczyć()

Utwórz obiekt AggregateField, którego można użyć do obliczenia liczby dokumentów w zestawie wyników zapytania.

Podpis:

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

Zwroty:

Aggregatefield <numer>

deletefield ()

Zwraca wartość do użytku z aktualizateC () lub setDoc () z {merge: true} , aby zaznaczyć pole do usunięcia.

Podpis:

export declare function deleteField(): FieldValue;

Zwroty:

Wartość pola

DocumentID ()

Zwraca specjalną FieldPath Sentinel w celu odniesienia się do identyfikatora dokumentu. Można go używać w zapytaniach do sortowania lub filtrowania według identyfikatora dokumentu.

Podpis:

export declare function documentId(): FieldPath;

Zwroty:

Ścieżka polowa

getfirestore ()

Zwraca istniejącą domyślną instancję Firestore , która jest powiązana z domyślnym FireBaseApp . Jeśli nie istnieje żadna instancja, inicjuje nową instancję z ustawieniami domyślnymi.

Podpis:

export declare function getFirestore(): Firestore;

Zwroty:

Firestore

Domyślna instancja Firestore aplikacji domyślnej.

pamięćagergarbageCollector ()

Tworzy instancję MemoryEagerGarbageCollector . Jest to również domyślny kolekcjoner śmieci, chyba że jest on wyraźnie określony inaczej.

Podpis:

export declare function memoryEagerGarbageCollector(): MemoryEagerGarbageCollector;

Zwroty:

MemoryEagergarbageCollector

uptandentMultipletaBManager ()

Tworzy instancję PersistentMultipleTabManager .

Podpis:

export declare function persistentMultipleTabManager(): PersistentMultipleTabManager;

Zwroty:

UptandentMultipletaBManager

servertimestamp ()

Zwraca wartość używaną z setDoc () lub aktualizateC () , aby zawierać znacznik czasu generowanego przez serwer w danych pisemnych.

Podpis:

export declare function serverTimestamp(): FieldValue;

Zwroty:

Wartość pola

funkcja (DatabaseID, ...)

getfirestore (batabaseID)

Ten interfejs API jest dostarczany jako podgląd dla programistów i może się zmienić na podstawie otrzymywanych informacji zwrotnych. Nie używaj tego interfejsu API w środowisku produkcyjnym.

Zwraca istniejącą wymienioną instancję Firestore , która jest powiązana z domyślnym FireBaseApp . Jeśli nie istnieje żadna instancja, inicjuje nową instancję z ustawieniami domyślnymi.

Podpis:

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

Parametry

Zwroty:

Firestore

Nazwana instancja Firestore aplikacji domyślnej.

funkcja (elementy, ...)

ArrayRemove (elementy)

Zwraca specjalną wartość, której można użyć z setDoc () lub każe serwerowi usunięcie podanych elementów z dowolnej wartości tablicy, która już istnieje na serwerze. Wszystkie instancje każdego określonego elementu zostaną usunięte z tablicy. If the field being modified is not already an array it will be overwritten with an empty array.

Podpis:

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

Parametry

Zwroty:

Wartość pola

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

arrayUnion(elements)

Returns a special value that can be used with setDoc() or updateDoc() that tells the server to union the given elements with any array value that already exists on the server. Each specified element that doesn't already exist in the array will be added to the end. If the field being modified is not already an array it will be overwritten with an array containing exactly the specified elements.

Podpis:

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

Parametry

Zwroty:

Wartość pola

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

function(field, ...)

average(field)

Create an AggregateField object that can be used to compute the average of a specified field over a range of documents in the result set of a query.

Podpis:

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

Parametry

Zwroty:

AggregateField <number | null>

sum(field)

Create an AggregateField object that can be used to compute the sum of a specified field over a range of documents in the result set of a query.

Podpis:

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

Parametry

Zwroty:

AggregateField <numer>

function(fieldPath, ...)

orderBy(fieldPath, directionStr)

Creates a QueryOrderByConstraint that sorts the query result by the specified field, optionally in descending order instead of ascending.

Podpis:

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

Parametry

Zwroty:

QueryOrderByConstraint

The created QueryOrderByConstraint .

where(fieldPath, opStr, value)

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

Podpis:

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

Parametry

Zwroty:

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.

Podpis:

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

Parametry

Zwroty:

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.

Podpis:

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

Parametry

Zwroty:

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.

Podpis:

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

Parametry

Zwroty:

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.

Podpis:

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

Parametry

Zwroty:

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.

Podpis:

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

Parametry

Zwroty:

próżnia

disablePersistentCacheIndexAutoCreation(indexManager)

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

Podpis:

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

Parametry

Zwroty:

próżnia

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.

Ta funkcja jest domyślnie wyłączona.

Podpis:

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

Parametry

Zwroty:

próżnia

function(left, ...)

aggregateFieldEqual(left, right)

Compares two 'AggregateField ` instances for equality.

Podpis:

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

Parametry

Zwroty:

wartość logiczna

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.

Podpis:

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

Parametry

Zwroty:

wartość logiczna

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.

Podpis:

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

Parametry

Zwroty:

wartość logiczna

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.

Podpis:

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

Parametry

Zwroty:

wartość logiczna

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.

Podpis:

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

Parametry

Zwroty:

wartość logiczna

true if the snapshots are equal.

function(limit, ...)

limit(limit)

Creates a QueryLimitConstraint that only returns the first matching documents.

Podpis:

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

Parametry

Zwroty:

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.

Podpis:

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

Parametry

Zwroty:

QueryLimitConstraint

The created QueryLimitConstraint .

function(logLevel, ...)

setLogLevel(logLevel)

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

Podpis:

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

Parametry

Zwroty:

próżnia

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.

Podpis:

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

Parametry

Zwroty:

Wartość pola

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.

Podpis:

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

Parametry

Zwroty:

Promise< AggregateQuerySnapshot <AggregateSpecType, AppModelType, DbModelType>>

Przykład

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.

Podpis:

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

Parametry

Zwroty:

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 .

Podpis:

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

Parametry

Zwroty:

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.

Podpis:

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

Parametry

Zwroty:

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.

Podpis:

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

Parametry

Zwroty:

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.

Podpis:

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;

Parametry

Zwroty:

Zrezygnuj z subskrypcji

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.

Podpis:

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;

Parametry

Zwroty:

Zrezygnuj z subskrypcji

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.

Podpis:

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;

Parametry

Zwroty:

Zrezygnuj z subskrypcji

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.

Podpis:

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;

Parametry

Zwroty:

Zrezygnuj z subskrypcji

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.

Podpis:

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

Parametry

Zwroty:

Zapytanie <AppModelType, DbModelType>

Wyjątki

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.

Podpis:

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

Parametry

Zwroty:

Zapytanie <AppModelType, DbModelType>

Wyjątki

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.

Podpis:

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

Parametry

Zwroty:

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.

Podpis:

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

Parametry

Zwroty:

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.

Podpis:

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

Parametry

Zwroty:

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 the specified relative path.

Podpis:

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

Parametry

Zwroty:

CollectionReference < DocumentData , DocumentData >

The CollectionReference instance.

Wyjątki

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 the specified relative path.

Podpis:

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

Parametry

Zwroty:

CollectionReference < DocumentData , DocumentData >

The CollectionReference instance.

Wyjątki

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 .

Podpis:

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

Parametry

Zwroty:

Promise<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 .

Podpis:

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

Parametry

Zwroty:

Odnośnik do dokumentu <AppModelType, DbModelType>

The DocumentReference instance.

Wyjątki

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.

Podpis:

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

Parametry

Zwroty:

Odnośnik do dokumentu < DocumentData , DocumentData >

The DocumentReference instance.

Wyjątki

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 .

Podpis:

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

Parametry

Zwroty:

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.

Podpis:

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

Parametry

Zwroty:

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.

Podpis:

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

Parametry

Zwroty:

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.

Podpis:

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;

Parametry

Zwroty:

Zrezygnuj z subskrypcji

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.

Podpis:

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;

Parametry

Zwroty:

Zrezygnuj z subskrypcji

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.

Podpis:

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;

Parametry

Zwroty:

Zrezygnuj z subskrypcji

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.

Podpis:

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;

Parametry

Zwroty:

Zrezygnuj z subskrypcji

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.

Podpis:

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

Parametry

Zwroty:

Promise<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.

Podpis:

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

Parametry

Zwroty:

Promise<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.

Podpis:

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

Parametry

Zwroty:

Promise<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.

Podpis:

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

Parametry

Zwroty:

Promise<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.

Podpis:

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

Parametry

Zwroty:

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).

Podpis:

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

Parametry

Zwroty:

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.

Podpis:

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

Parametry

Zwroty:

PersistentLocalCache

persistentSingleTabManager(settings)

Creates an instance of PersistentSingleTabManager .

Podpis:

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

Parametry

Zwroty:

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.

Podpis:

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

Parametry

Zwroty:

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.

Podpis:

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

Parametry

Zwroty:

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.

Podpis:

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

Parametry

Zwroty:

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.

Podpis:

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

Parametry

Zwroty:

QueryStartAtConstraint

A QueryStartAtConstraint to pass to query() .

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.

Podpis:

CACHE_SIZE_UNLIMITED = -1

AddPrefixToKeys

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

Podpis:

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.

Podpis:

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 .

Podpis:

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.

Podpis:

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

Podpis:

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

Podpis:

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.

Podpis:

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.

Podpis:

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.

Podpis:

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

MemoryGarbageCollector

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

Podpis:

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

Podpis:

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).

Podpis:

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.

Podpis:

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.

Podpis:

export declare type PersistentTabManager = PersistentSingleTabManager | PersistentMultipleTabManager;

Prymitywny

Primitive types.

Podpis:

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

QueryConstraintType

Describes the different query constraints available in this SDK.

Podpis:

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

QueryFilterConstraint

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

Podpis:

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 .

Podpis:

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 .

Podpis:

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

TaskState

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.

Podpis:

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

Podpis:

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

Aktualizować dane

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

Podpis:

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

WhereFilterOp

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

Podpis:

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

WithFieldValue

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

Podpis:

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