@firebase/firestore

Domyślne wystąpienie Firestore podanej aplikacji.

getFirestore(aplikacja; identyfikator bazy danych)

Ten interfejs API jest dostępny w wersji testowej dla deweloperów i może się zmienić w zależności od otrzymanych opinii. Nie używaj tego interfejsu API w środowisku produkcyjnym.

Zwraca istniejącą instancję o nazwie Firestore, która jest powiązana z podaną aplikacją FirebaseApp. Jeśli żadna instancja nie istnieje, inicjuje nową z ustawieniami domyślnymi.

Podpis:

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

Parametry

Parametr	Typ	Opis
aplikacja	Aplikacja Firebase	Instancja FirebaseApp, z którą jest powiązana zwrócona instancja Firestore.
identyfikator bazy danych	ciąg znaków	Nazwa bazy danych.

Zwroty:

Nazwa instancji Firestore podanej aplikacji.

zainicjujFirestore(aplikacja; ustawienia; identyfikator_bazy danych)

Inicjuje nową instancję Firestore z podanymi ustawieniami. Może zostać wywołana tylko przed innymi funkcjami, w tym getFirestore(). Jeśli ustawienia niestandardowe są puste, ta funkcja odpowiada wywołaniu getFirestore().

Podpis:

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

Parametry

Parametr	Typ	Opis
aplikacja	Aplikacja Firebase	FirebaseApp, z którą zostanie powiązane wystąpienie Firestore.
ustawienia	Ustawienia Firestore	Obiekt ustawień służący do konfigurowania instancji Firestore.
identyfikator bazy danych	ciąg znaków	Nazwa bazy danych.

Zwroty:

CollectionReference<DocumentData, DocumentData>

Nowo zainicjowana instancja Firestore.

funkcja(firestore, ...)

ClearIndexedDbPersistence(firestore)

Czyści pamięć trwałą. Obejmuje to oczekujące zapisy i dokumenty przechowywane w pamięci podręcznej.

Musi być wywoływana, gdy instancja Firestore nie została uruchomiona (po zamknięciu lub zainicjowaniu aplikacji). Podczas uruchamiania ta funkcja musi zostać wywołana przed innymi funkcjami (innymi niż initializeFirestore() i getFirestore()). Jeśli instancja Firestore jest nadal uruchomiona, obietnica zostanie odrzucona z kodem błędu failed-precondition.

Podpis:

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

Parametry

Parametr	Typ	Opis
firestore	Firestore	Instancja Firestore, dla której ma zostać wyczyszczona trwałość.

Zwroty:

Obietnica<void>

Promise, który jest rozpoznawany po wyczyszczeniu pamięci trwałej. W przeciwnym razie obietnica zostanie odrzucona z powodu błędu.

kolekcja(firestore, Path, PathSegments)

Pobiera instancję CollectionReference odwołującą się do kolekcji w podanej ścieżce bezwzględnej.

Podpis:

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

Parametry

Parametr	Typ	Opis
firestore	Firestore	Odwołanie do głównej instancji `Firestore`.
ścieżka	ciąg znaków	Rozdzielona ukośnikiem ścieżka do kolekcji.
segmenty ścieżki	ciąg znaków[]	Dodatkowe segmenty ścieżki do zastosowania w odniesieniu do pierwszego argumentu.

Zwroty:

Instancja CollectionReference.

Wyjątki

Końcowa ścieżka ma parzystą liczbę segmentów i nie wskazuje zbioru.

grupa_kolekcji(firestore, identyfikator kolekcji)

Tworzy i zwraca nową instancję Query, która obejmuje wszystkie dokumenty w bazie danych znajdujące się w kolekcji lub podkolekcji o określonym collectionId.

Podpis:

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

Parametry

Parametr	Typ	Opis
firestore	Firestore	Odwołanie do głównej instancji `Firestore`.
identyfikator kolekcji	ciąg znaków	Identyfikuje kolekcje, których ma dotyczyć zapytanie. Uwzględniona zostanie każda kolekcja lub podkolekcja o tym identyfikatorze, który jest ostatnim segmentem jej ścieżki. Nie może zawierać ukośnika.

Zwroty:

Zapytanie<DocumentData, DocumentData>

Utworzono: Query.

ConnectFirestoreEmulator(firestore, host, port, options)

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

Parametr	Typ	Opis
firestore	Firestore	Instancja `Firestore`, która ma zostać skonfigurowana pod kątem połączenia z emulatorem.
host	ciąg znaków	hosta emulatora (np. localhost).
port	liczba	port emulatora (np. 9000).
opcje	{ mockUserToken?: EmulatorMockTokenOptions \| string;

Zwroty:

nieważne

disabledNetwork(firestore)

Wyłącza korzystanie z sieci przez tę instancję. Można ją ponownie włączyć za pomocą funkcji enableNetwork(). Gdy sieć jest wyłączona, wszystkie detektory zrzutów, wywołania getDoc() lub getDocs() będą zwracać wyniki z pamięci podręcznej, a wszystkie operacje zapisu będą umieszczane w kolejce do czasu przywrócenia sieci.

Podpis:

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

Parametry

Parametr	Typ	Opis
firestore	Firestore

Zwroty:

Obietnica<void>

Komunikat Promise, który jest usuwany po wyłączeniu sieci.

doc(firestore, ścieżka, PathSegments)

Pobiera wystąpienie DocumentReference odwołujące się do dokumentu w podanej ścieżce bezwzględnej.

Podpis:

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

Parametry

Parametr	Typ	Opis
firestore	Firestore	Odwołanie do głównej instancji `Firestore`.
ścieżka	ciąg znaków	Ścieżka do dokumentu rozdzielana ukośnikami.
segmenty ścieżki	ciąg znaków[]	Dodatkowe segmenty ścieżki, które zostaną zastosowane w stosunku do pierwszego argumentu.

Zwroty:

DocumentReference<DocumentData, DocumentData>

Instancja DocumentReference.

Wyjątki

Jeśli końcowa ścieżka ma nieparzystą liczbę segmentów i nie wskazuje dokumentu.

allowIndexedDbPersistence(firestore, cookiesSettings)

Ostrzeżenie: ten interfejs API jest już nieaktualny.

Ta funkcja zostanie usunięta w przyszłej głównej wersji. Zamiast tego ustaw FirestoreSettings.localCache na instancję PersistentLocalCache, aby włączyć pamięć podręczną IndexedDb. Wywołanie tej funkcji, gdy jest już określony atrybut FirestoreSettings.localCache, spowoduje zgłoszenie wyjątku.

Próbuje włączyć pamięć trwałą, jeśli to możliwe.

W przypadku niepowodzenia enableIndexedDbPersistence() odrzuci obietnicę lub zgłosi wyjątek. Istnieje kilka możliwych przyczyn niepowodzenia. Rozpoznasz je po komunikacie code o błędzie.

* nieudany warunek wstępny: aplikacja jest już otwarta w innej karcie przeglądarki. * nie zaimplementowano: przeglądarka jest niezgodna z implementacją trwałości offline.

Pamiętaj, że nawet po awarii instancja Firestore pozostanie gotowa do użycia, ale trwała w trybie offline zostanie wyłączona.

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

Podpis:

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

Parametry

Parametr	Typ	Opis
firestore	Firestore	Instancja Firestore, dla której chcesz włączyć trwałość.
Ustawienia trwałości	Ustawienia trwałości	Opcjonalny obiekt ustawień umożliwiający skonfigurowanie trwałości.

Zwroty:

Obietnica<void>

Promise reprezentujący włączenie pamięci trwałej.

włączMultiTabIndexedDbPersistence(firestore)

Ostrzeżenie: ten interfejs API jest już nieaktualny.

Ta funkcja zostanie usunięta w przyszłej głównej wersji. Zamiast tego ustaw FirestoreSettings.localCache na instancję PersistentLocalCache, aby włączyć pamięć podręczną Indexdb. Wywołanie tej funkcji, gdy jest już określony atrybut FirestoreSettings.localCache, spowoduje zgłoszenie wyjątku.

Próbuje włączyć pamięć trwałą z wieloma kartami, jeśli to możliwe. Jeśli ta opcja zostanie włączona na wszystkich kartach, wszystkie operacje współdzielą dostęp do trwałości lokalnej, w tym wspólne wykonywanie zapytań i kompensowane opóźnienia aktualizacji dokumentów lokalnych we wszystkich połączonych instancjach.

W przypadku niepowodzenia enableMultiTabIndexedDbPersistence() odrzuci obietnicę lub zgłosi wyjątek. Istnieje kilka możliwych przyczyn niepowodzenia. Rozpoznasz je po komunikacie code o błędzie.

* nieudany warunek wstępny: aplikacja jest już otwarta w innej karcie przeglądarki, a tryb wielu kart nie jest włączony. * nie zaimplementowano: przeglądarka jest niezgodna z implementacją trwałości offline.

Pamiętaj, że nawet po awarii instancja Firestore pozostanie gotowa do użycia, ale trwała w trybie offline zostanie wyłączona.

Podpis:

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

Parametry

Parametr	Typ	Opis
firestore	Firestore	Instancja Firestore, dla której chcesz włączyć trwałość.

Zwroty:

Obietnica<void>

Promise reprezentujący włączenie pamięci trwałej.

allowNetwork(firestore)

Ponownie włącza korzystanie z sieci w przypadku instancji Firestore po wcześniejszym wywołaniu funkcji disableNetwork().

Podpis:

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

Parametry

Parametr	Typ	Opis
firestore	Firestore

Zwroty:

Obietnica<void>

Promise, który jest zamykany po włączeniu sieci.

getPersistentCacheIndexManager(firestore)

Zwraca menedżer indeksu PersistentCache używany przez dany obiekt Firestore.

Instancja PersistentCacheIndexManager lub null, jeśli lokalna pamięć trwała nie jest używana.

Podpis:

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

Parametry

Parametr	Typ	Opis
firestore	Firestore

Zwroty:

PersistentCacheIndexManager | wartość null

loadBundle(firestore, bundleData)

Wczytuje pakiet Firestore do lokalnej pamięci podręcznej.

Podpis:

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

Parametry

Parametr	Typ	Opis
firestore	Firestore	Instancja Firestore, dla której mają być ładowane pakiety.
pakietDane	ReadableStream<Uint8tablica> \| SlateBuffer \| tekst	Obiekt reprezentujący pakiet do wczytania. Prawidłowe obiekty to `ArrayBuffer`, `ReadableStream<Uint8Array>` lub `string`.

Zwroty:

LoadBundleTask

Obiekt LoadBundleTask, który powiadamia rozmówców o aktualizacjach postępu oraz zdarzeniach ukończenia lub błędu. Można go użyć jako Promise<LoadBundleTaskProgress>.

nameQuery(firestore, name)

Odczytuje zapytanie Firestore z lokalnej pamięci podręcznej o podanej nazwie.

Nazwane zapytania są spakowane w pakiety po stronie serwera (wraz z powiązanymi dokumentami) i ładowane do lokalnej pamięci podręcznej za pomocą loadBundle. W 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

Parametr	Typ	Opis
firestore	Firestore	Instancja Firestore, z której ma być odczytywane zapytanie.
nazwa	ciąg znaków	Nazwa zapytania.

Zwroty:

Obietnica <zapytanie | null>

Wartość Promise, która została rozwiązana za pomocą zapytania lub null.

onSnapshotsInSync(firestore, obserwator)

Dodaje detektor zdarzenia synchronizacji zrzutów. Zdarzenie zrzutów ekranu w synchronizacji wskazuje, że uruchomili się wszystkie detektory, których dotyczy dana zmiana, nawet jeśli pojedyncza zmiana wygenerowana przez serwer dotyczy wielu detektorów.

UWAGA: zdarzenie synchronizacji zrzutów wskazuje jedynie, że detektory są zsynchronizowane ze sobą, ale nie ma wpływu na to, czy te zrzuty są zsynchronizowane z serwerem. Użyj SnapshotMetadata w poszczególnych detektorach, aby określić, czy zrzut pochodzi z pamięci podręcznej, czy z serwera.

Podpis:

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

Parametry

Parametr	Typ	Opis
firestore	Firestore	Instancja Firestore na potrzeby synchronizowania zrzutów.
obserwator	{ następny?: (wartość: void) => void; ? (błąd: FirestoreError) => void; zakończono?: () => void;	Pojedynczy obiekt zawierający wywołania zwrotne `next` i `error`.

Zwroty:

Funkcja anulowania subskrypcji, którą można wywołać w celu anulowania detektora zrzutów.

onSnapshotsInSync(firestore, onSync)

UWAGA: zdarzenie synchronizacji zrzutów wskazuje jedynie, że detektory są zsynchronizowane ze sobą, ale nie ma wpływu na to, czy te zrzuty są zsynchronizowane z serwerem. Użyj właściwości SnapshotMetadata w poszczególnych detektorach, aby określić, czy zrzut pochodzi z pamięci podręcznej czy z serwera.

Podpis:

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

Parametry

Parametr	Typ	Opis
firestore	Firestore	Instancja `Firestore` do synchronizowania zrzutów.
onSync	() => nieważne	Wywołanie zwrotne, które ma być wywoływane za każdym razem, gdy wszystkie detektory zrzutów są ze sobą zsynchronizowane.

Zwroty:

Funkcja anulowania subskrypcji, którą można wywołać w celu anulowania detektora zrzutów.

runTransaction(firestore, updateFunction, opcje)

Wykonuje określony updateFunction, a następnie próbuje zatwierdzić zmiany zastosowane w transakcji. Jeśli jakikolwiek odczytywany dokument w transakcji uległ zmianie, Cloud Firestore ponawia próbę wykonania operacji updateFunction. Jeśli nie uda się potwierdzić po 5 próbach, transakcja zakończy się niepowodzeniem.

Maksymalna dozwolona liczba zapisów w jednej transakcji to 500.

Podpis:

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

Parametry

Parametr	Typ	Opis
firestore	Firestore	Odwołanie do bazy danych Firestore, w odniesieniu do której ma zostać uruchomiona ta transakcja.
funkcja updateFunction	(transaction: Transaction) => Obietnica<T>	Funkcja do wykonania w kontekście transakcji.
opcje	TransactionOptions (Opcje transakcji).	Obiekt opcji służący do konfigurowania maksymalnej liczby prób do zatwierdzenia.

Zwroty:

Obietnica<T>

Jeśli transakcja została ukończona lub została jawnie przerwana (updateFunction zwrócił nieudaną obietnicę), w tym miejscu zwracana jest obietnica zwrócona przez obiekt updateFunction. W przeciwnym razie, jeśli transakcja się nie udała, zwracana jest odrzucona obietnica z odpowiednim błędem błędu.

setIndexConfiguration(firestore, konfiguracja)

Ten interfejs API jest dostępny w wersji testowej dla deweloperów i może się zmienić w zależności od otrzymanych opinii. Nie używaj tego interfejsu API w środowisku produkcyjnym.

Ostrzeżenie: ten interfejs API jest teraz nieaktualny.

Zamiast ręcznie tworzyć indeksy pamięci podręcznej, rozważ użycie metody enablePersistentCacheIndexAutoCreation(), aby umożliwić pakietowi SDK podjęcie decyzji, czy utworzyć indeksy pamięci podręcznej dla zapytań wykonywanych lokalnie.

Konfiguruje indeksowanie na potrzeby lokalnego wykonywania zapytań. Każda wcześniejsza konfiguracja indeksu zostanie zastąpiona. Promise rozwiązuje problem po utrwaleniu konfiguracji indeksu.

Wpisy indeksu są tworzone asynchronicznie. Z zapytań, które wymagają indeksowania, możesz nadal korzystać, nawet jeśli indeksy nie są jeszcze dostępne. Wykonanie zapytania zacznie automatycznie korzystać z indeksu po zapisaniu wpisów indeksu.

Indeksy są obsługiwane tylko z trwałością IndexedDb. Jeśli zasada IndexedDb nie jest włączona, każda konfiguracja indeksu jest ignorowana.

Podpis:

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

Parametry

Parametr	Typ	Opis
firestore	Firestore	Instancja Firestore, dla której mają być skonfigurowane indeksy.
konfiguracja	IndexConfiguration	Definicja indeksu.

Zwroty:

Obietnica<void>

Wartość Promise, która wygasa po skonfigurowaniu wszystkich indeksów.

Wyjątki

FirestoreError, jeśli format JSON jest nieprawidłowy.

setIndexConfiguration(firestore, json)

Ten interfejs API jest dostępny w wersji testowej dla deweloperów i może się zmienić w zależności od otrzymanych opinii. Nie używaj tego interfejsu API w środowisku produkcyjnym.

Ostrzeżenie: ten interfejs API jest teraz nieaktualny.

Zamiast ręcznie tworzyć indeksy pamięci podręcznej, rozważ użycie metody enablePersistentCacheIndexAutoCreation(), aby umożliwić pakietowi SDK podjęcie decyzji, czy utworzyć indeksy pamięci podręcznej dla zapytań wykonywanych lokalnie.

Konfiguruje indeksowanie na potrzeby lokalnego wykonywania zapytań. Każda wcześniejsza konfiguracja indeksu zostanie zastąpiona. Promise rozwiązuje problem po utrwaleniu konfiguracji indeksu.

Indeksy są obsługiwane tylko z trwałością IndexedDb. Przed ustawieniem konfiguracji indeksu wywołaj enableIndexedDbPersistence() lub enableMultiTabIndexedDbPersistence(). Jeśli zasada IndexedDb nie jest włączona, każda konfiguracja indeksu jest ignorowana.

Metoda akceptuje format JSON wyeksportowany przez interfejs wiersza poleceń Firebase (firebase firestore:indexes). Jeśli format JSON jest nieprawidłowy, ta metoda zwraca błąd.

Podpis:

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

Parametry

Parametr	Typ	Opis
firestore	Firestore	Instancja Firestore, dla której mają być skonfigurowane indeksy.
JSON	ciąg znaków	Format JSON wyeksportowany przez interfejs wiersza poleceń Firebase.

Zwroty:

Obietnica<void>

Wartość Promise, która wygasa po skonfigurowaniu wszystkich indeksów.

Wyjątki

FirestoreError, jeśli format JSON jest nieprawidłowy.

zakończyć(firestore)

Zamyka podaną instancję Firestore.

Po wywołaniu funkcji terminate() można używać tylko funkcji clearIndexedDbPersistence(). Każda inna funkcja zgłasza FirestoreError.

Aby uruchomić ponownie po zakończeniu działania, utwórz nową instancję FirebaseFirestore z funkcją getFirestore().

Zakończenie nie powoduje anulowania oczekujących zapisów, a wszystkie obietnice, które oczekują na odpowiedź z serwera, nie zostaną zrealizowane. Jeśli masz włączoną trwałość, po następnym uruchomieniu tej instancji wznowi ona wysyłanie tych zapisów do serwera.

Podpis:

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

Parametry

Parametr	Typ	Opis
firestore	Firestore

Zwroty:

Obietnica<void>

Promise, który jest rozstrzygnięty po zakończeniu działania instancji.

waitForPendingWrites(firestore)

Czekam, aż wszystkie aktualnie oczekujące zapisy aktywnego użytkownika zostaną potwierdzone przez backend.

Jeśli nie ma zaległych zapisów, zwrócona obietnica wygasa natychmiast. W przeciwnym razie obietnica czeka na wszystkie wcześniej wykonane zapisy (w tym te zapisane w poprzedniej sesji aplikacji), ale nie czeka na zapisy dodane po wywołaniu funkcji. Jeśli chcesz poczekać na dodatkowe zapisy, zadzwoń ponownie pod numer waitForPendingWrites().

Wszystkie zaległe obietnice waitForPendingWrites() są odrzucane podczas wprowadzania zmian dotyczących użytkownika.

Podpis:

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

Parametry

Parametr	Typ	Opis
firestore	Firestore

Zwroty:

Obietnica<void>

Promise, który rozwiązuje się, gdy wszystkie aktualnie oczekujące zapisy zostaną potwierdzone przez backend.

zapis wsadowy(firestore)

Tworzy wsad zapisu służącą do wykonywania wielu zapisów jako pojedynczej operacji niepodzielnej. Maksymalna dozwolona liczba zapisów w pojedynczej operacji WriteBatch to 500.

W przeciwieństwie do transakcji partie zapisu są zachowywane offline, dlatego są zalecane, gdy nie musisz uwarunkować zapisów na odczytywanych danych.

Podpis:

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

Parametry

Parametr	Typ	Opis
firestore	Firestore

Zwroty:

Zapis wsadowy

Element WriteBatch, który może być używany do atomowego wykonywania wielu zapisów.

funkcja()

count()

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

Podpis:

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

Zwroty:

AggregateField<numer>

deleteField()

Zwraca czujnik do użycia z funkcją updateDoc() lub setDoc() z funkcją {merge: true} do oznaczenia pola do usunięcia.

Podpis:

export declare function deleteField(): FieldValue;

Zwroty:

documentId()

Zwraca specjalny wskaźnik FieldPath, który odnosi się do identyfikatora dokumentu. Można go używać w zapytaniach do sortowania i filtrowania według identyfikatora dokumentu.

Podpis:

export declare function documentId(): FieldPath;

Zwroty:

FieldPath

getFirestore()

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

Podpis:

export declare function getFirestore(): Firestore;

Zwroty:

MemoryEagerGarbageCollector

Domyślne wystąpienie Firestore aplikacji domyślnej.

PamięciEagerGarbageCollector()

Tworzy instancję MemoryEagerGarbageCollector. Jest to również domyślny moduł do czyszczenia pamięci, chyba że wyraźnie określono inaczej.

Podpis:

export declare function memoryEagerGarbageCollector(): MemoryEagerGarbageCollector;

Zwroty:

StałyMultipleTabManager()

Tworzy instancję PersistentMultipleTabManager.

Podpis:

export declare function persistentMultipleTabManager(): PersistentMultipleTabManager;

Zwroty:

PersistentMultipleTabManager

servertimestamp()

Zwraca wartość czujnika używaną z funkcją setDoc() lub updateDoc(), aby uwzględnić w zapisanych danych sygnaturę czasową wygenerowaną przez serwer.

Podpis:

export declare function serverTimestamp(): FieldValue;

Zwroty:

funkcji(identyfikatorbazy_danych, ...)

getFirestore(databaseId)

Ten interfejs API jest dostępny w wersji testowej dla deweloperów i może się zmienić w zależności od otrzymanych opinii. Nie używaj tego interfejsu API w środowisku produkcyjnym.

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

Podpis:

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

Parametry

Parametr	Typ	Opis
identyfikator bazy danych	ciąg znaków	Nazwa bazy danych.

Zwroty:

Instancja Firestore o nazwie domyślnej aplikacji.

funkcja(elementy, ...)

tablicaRemove(elements)

Zwraca wartość specjalną, której można użyć z funkcją setDoc() lub informuje serwer, że ma usunąć podane elementy z dowolnej wartości tablicy, która już istnieje na serwerze. Wszystkie wystąpienia każdego określonego elementu zostaną usunięte z tablicy. Jeśli modyfikowane pole nie jest jeszcze tablicą, zostanie zastąpione pustą tablicą.

Podpis:

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

Parametry

Parametr	Typ	Opis
elementy	nieznana[]	Elementy do usunięcia z tablicy.

Zwroty:

Wieża FieldValue do użycia w wywołaniu z setDoc() lub updateDoc()

tablicaUnion(elementy)

Zwraca wartość specjalną, której można użyć w przypadku funkcji setDoc() lub updateDoc(), która informuje serwer, że ma połączyć podane elementy z dowolną wartością tablicy, która już istnieje na serwerze. Każdy określony element, którego jeszcze nie ma w tablicy, zostanie dodany na końcu. Jeśli modyfikowane pole nie jest jeszcze tablicą, zostanie ona zastąpiona tablicą zawierającą dokładnie określone elementy.

Podpis:

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

Parametry

Parametr	Typ	Opis
elementy	nieznana[]	Elementy, które mają zostać połączone z tablicą.

Zwroty:

QueryFieldFilterConstraint

wartownik FieldValue do użycia w wywołaniu setDoc() lub updateDoc().

funkcja(pole, ...)

średnia(pole)

Utwórz obiekt AggregateField, którego można używać do obliczania średniej wartości z określonego pola dla zakresu dokumentów w zbiorze wynikowym zapytania.

Podpis:

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

Parametry

Parametr	Typ	Opis
pole	ciąg znaków \| FieldPath	Określa pole do uśrednienia w zestawie wyników.

Zwroty:

AggregateField<numer | null>

suma(pole)

Utwórz obiekt AggregateField, którego można używać do obliczania sumy określonego pola w zakresie dokumentów w zbiorze wynikowym zapytania.

Podpis:

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

Parametry

Parametr	Typ	Opis
pole	ciąg znaków \| FieldPath	Określa pole do zsumowania w zbiorze wyników.

Zwroty:

AggregateField<numer>

function(fieldPath, ...)

orderBy(fieldPath, directionsStr)

Tworzy funkcję QueryOrderByConstraint, która sortuje wynik zapytania według podanego pola (opcjonalnie w kolejności malejącej, a nie rosnąco).

Podpis:

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

Parametry

Parametr	Typ	Opis
FieldPath	ciąg znaków \| FieldPath	Pole, według którego ma być sortowane.
KierunekStr	OrderByDirection (Zamówienie w kierunku zamówienia)	Opcjonalny kierunek sortowania „asc” lub „malejąco”). Jeśli nie podasz żadnej wartości, będzie rosnąć.

Zwroty:

QueryOrderByConstraint

Utworzono QueryOrderByConstraint.

gdzie(polePath, opStr, wartość)

Tworzy obiekt QueryFieldFilterConstraint, który wymusza, by dokumenty zawierały określone pole, a wartość spełniała podane ograniczenie relacji.

Podpis:

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

Parametry

Parametr	Typ	Opis
FieldPath	ciąg znaków \| FieldPath	Ścieżka do porównania
opStr	whereFilterOp	Ciąg operacji (np. "<", "<=", "==", "<", "<=", "!=").
wartość	nieznany	Wartość do porównania

Zwroty:

Utworzono QueryFieldFilterConstraint.

function(fieldValues, ...)

endAt(fieldValues)

Tworzy obiekt QueryEndAtConstraint, który zmienia wyniki tak, aby kończyć się w podanych polach względem kolejności zapytania. Kolejność wartości pól musi być zgodna z kolejnością klauzul zapytania.

Podpis:

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

Parametry

Parametr	Typ	Opis
PoleValues (wartości pola)	nieznana[]	Wartości pól, na których ma się zakończyć to zapytanie, w kolejności według:

Zwroty:

Element QueryEndAtConstraint przekazywany do funkcji query()

endBefore(fieldValues)

Tworzy obiekt QueryEndAtConstraint, który zmienia wynik tak, aby kończył się przed podanymi polami zgodnie z kolejnością zapytania. Kolejność wartości pól musi być zgodna z kolejnością klauzul zapytania.

Podpis:

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

Parametry

Parametr	Typ	Opis
PoleValues (wartości pola)	nieznana[]	Wartości pól, które mają zakończyć to zapytanie, w kolejności według:

Zwroty:

Element QueryEndAtConstraint przekazywany do funkcji query()

startAfter(fieldValues)

Tworzy obiekt QueryStartAtConstraint, który modyfikuje zbiór wyników tak, aby rozpoczynał się po podanych polach zgodnie z kolejnością zapytania. Kolejność wartości pól musi być zgodna z kolejnością klauzul zapytania.

Podpis:

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

Parametry

Parametr	Typ	Opis
PoleValues (wartości pola)	nieznana[]	Wartości pól, po których ma się rozpoczynać to zapytanie, w kolejności zależnej od ich kolejności.

Zwroty:

Element QueryStartAtConstraint przekazywany do funkcji query()

startAt(fieldValues)

Tworzy obiekt QueryStartAtConstraint, który modyfikuje zbiór wyników tak, aby rozpoczynał się od podanych pól względem kolejności zapytania. Kolejność wartości pól musi być zgodna z kolejnością klauzul zapytania.

Podpis:

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

Parametry

Parametr	Typ	Opis
PoleValues (wartości pola)	nieznana[]	Wartości pól, od których ma się rozpoczynać to zapytanie, w kolejności zależnej od ich kolejności.

Zwroty:

Typ QueryStartAtConstraint przekazywany do funkcji query().

function(indexManager, ...)

deleteAllPersistentCacheIndexes(indexManager)

Usuwa wszystkie indeksy stałej pamięci podręcznej.

Pamiętaj, że ta funkcja usuwa też indeksy wygenerowane przez wycofaną wersję setIndexConfiguration().

Podpis:

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

Parametry

Parametr	Typ	Opis
menedżer indeksu	PersistentCacheIndexManager

Zwroty:

nieważne

disabledPersistentCacheIndexAutoCreation(indexManager)

Zatrzymuje automatyczne tworzenie indeksów stałych pamięci podręcznej na potrzeby wykonywania zapytań lokalnych. Indeksy utworzone przez wywołanie metody enablePersistentCacheIndexAutoCreation() nadal obowiązują.

Podpis:

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

Parametry

Parametr	Typ	Opis
menedżer indeksu	PersistentCacheIndexManager

Zwroty:

nieważne

włączPersistentCacheIndexAutoCreation(indexManager)

Umożliwia pakietowi SDK automatyczne tworzenie indeksów trwałej pamięci podręcznej na potrzeby lokalnego wykonywania zapytań, jeśli pakiet SDK uważa, że indeksy pamięci podręcznej mogą zwiększyć wydajność.

Ta funkcja jest domyślnie wyłączona.

Podpis:

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

Parametry

Parametr	Typ	Opis
menedżer indeksu	PersistentCacheIndexManager

Zwroty:

nieważne

funkcja(po lewej, ...)

zbiorczeFieldEqual(po lewej, po prawej)

Porównuje 2 instancje „AggregateField”, aby zapewnić równość.

Podpis:

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

Parametry

Parametr	Typ	Opis
lewa	AggregateField<nieznana>	Porównaj to pole AggregateField z polem `right`.
prawa	AggregateField<nieznana>	Porównaj to pole AggregateField z polem `left`.

Zwroty:

wartość logiczna

zbiorczeQuerySnapshotEqual(po lewej, po prawej)

Porównuje 2 instancje AggregateQuerySnapshot pod kątem równości.

2 instancje typu AggregateQuerySnapshot są uznawane za „równe” jeśli mają podstawowe zapytania, które porównują te same dane.

Podpis:

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

Parametry

Parametr	Typ	Opis
lewa	AggregateQuerySnapshot<AggregateSpecType, AppModelType, DbModelType>	Pierwsze `AggregateQuerySnapshot` do porównania.
prawa	AggregateQuerySnapshot<AggregateSpecType, AppModelType, DbModelType>	Drugie pole `AggregateQuerySnapshot` do porównania.

Zwroty:

wartość logiczna

true, jeśli obiekty są „równe”, jak określono powyżej, lub false w innym przypadku.

queryEqual(lewo; prawo)

Zwraca wartość „prawda”, jeśli podane zapytania wskazują tę samą kolekcję i stosują te same ograniczenia.

Podpis:

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

Parametry

Parametr	Typ	Opis
lewa	Zapytanie<AppModelType, DbModelType>	`Query` do porównania.
prawa	Zapytanie<AppModelType, DbModelType>	`Query` do porównania.

Zwroty:

wartość logiczna

true (prawda), jeśli odwołania wskazują tę samą lokalizację w tej samej bazie danych Firestore.

refEqual(po lewej, po prawej)

Zwraca wartość prawda, jeśli podane odwołania są równe.

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

Parametr	Typ	Opis
lewa	DocumentReference<AppModelType, DbModelType> \| CollectionReference<AppModelType, DbModelType>	Odwołanie do porównania.
prawa	DocumentReference<AppModelType, DbModelType> \| CollectionReference<AppModelType, DbModelType>	Odwołanie do porównania.

Zwroty:

wartość logiczna

true (prawda), jeśli odwołania wskazują tę samą lokalizację w tej samej bazie danych Firestore.

zrzut równa(po lewej, po prawej)

Zwraca wartość „prawda”, jeśli podane zrzuty są równe.

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

Parametr	Typ	Opis
lewa	DocumentSnapshot<AppModelType, DbModelType> \| Zrzut zapytania<AppModelType, DbModelType>	Migawka do porównania.
prawa	DocumentSnapshot<AppModelType, DbModelType> \| Zrzut zapytania<AppModelType, DbModelType>	Migawka do porównania.

Zwroty:

wartość logiczna

true (prawda), jeśli zrzuty są równe.

funkcja(limit, ...)

limit(limit)

Tworzy zasadę QueryLimitConstraint, która zwraca tylko pierwsze pasujące dokumenty.

Podpis:

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

Parametry

Parametr	Typ	Opis
limit	liczba	Maksymalna liczba produktów do zwrotu.

Zwroty:

QueryLimitConstraint

Utworzono QueryLimitConstraint.

limitToLast(limit)

Tworzy zasadę QueryLimitConstraint, która zwraca tylko ostatnie pasujące dokumenty.

Dla zapytań limitToLast musisz określić co najmniej 1 klauzulę orderBy. W przeciwnym razie podczas wykonywania zostanie zgłoszony wyjątek.

Podpis:

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

Parametry

Parametr	Typ	Opis
limit	liczba	Maksymalna liczba produktów do zwrotu.

Zwroty:

QueryLimitConstraint

Utworzono QueryLimitConstraint.

function(logLevel, ...)

setLogLevel(logLevel)

Ustawia szczegółowość logów Cloud Firestore (debugowanie, błędy lub ciche).

Podpis:

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

Parametry

Parametr	Typ	Opis
poziom logu	Poziom logu	Szczegółowość ustawiona w przypadku rejestrowania aktywności i błędów. Może mieć dowolną z tych wartości: `debug` dla najbardziej szczegółowego poziomu rejestrowania, głównie na potrzeby debugowania. `error`, aby rejestrować tylko błędy. `silent to turn off logging.`

Zwroty:

nieważne

funkcja(n, ...)

przyrost(n)

Zwraca wartość specjalną, której można użyć z funkcją setDoc() lub updateDoc(), która informuje serwer, że ma zwiększyć bieżącą wartość pola o podaną wartość.

Jeśli operand lub wartość pola bieżącej wykorzystuje precyzję zmiennoprzecinkową, wszystkie funkcje arytmetyczne są zgodne z semantyką IEEE 754. Jeśli obie wartości są liczbami całkowitymi, wartości spoza bezpiecznego zakresu liczbowego kodu JavaScript (Number.MIN_SAFE_INTEGER–Number.MAX_SAFE_INTEGER) również podlegają utracie dokładności. Ponadto po przetworzeniu przez backend Firestore wszystkie operacje na liczbach całkowitych są ograniczone z zakresu od -2^63 do 2^63-1.

Jeśli bieżąca wartość pola nie ma typu number lub jeśli pole jeszcze nie istnieje, przekształcenie ustawia w polu podaną wartość.

Podpis:

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

Parametry

Parametr	Typ	Opis
n	liczba	Wartość, o którą ma być zwiększana.

Zwroty:

Wieża FieldValue do użycia w wywołaniu z setDoc() lub updateDoc()

funkcja(zapytanie; ...)

getAggregateFromServer(zapytanie, agregujące specyfikacje)

Oblicza określone agregacje na dokumentach w zestawie wyników danego zapytania bez pobierania dokumentów.

Korzystanie z tej funkcji do przeprowadzania agregacji jest skuteczne, ponieważ tylko ostateczne wartości agregacji, a nie wartości dokumentów danych. Ta funkcja może agregować dokumenty, gdy zbiór wyników jest zbyt duży do pobrania w całości (tysiące dokumentów).

Wynik odebrany z serwera jest prezentowany bez zmian i bez uwzględniania stanu lokalnego. Oznacza to, że dokumenty w lokalnej pamięci podręcznej nie są brane pod uwagę. Podobnie lokalne modyfikacje nie są jeszcze synchronizowane z serwerem. Wyniki pobrane wcześniej nie są używane. Każde wywołanie tej funkcji wiąże się z połączeniem z serwerem w obie strony.

Podpis:

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

Parametry

Parametr	Typ	Opis
zapytanie	Zapytanie<AppModelType, DbModelType>	Zapytanie, którego zbiór wyników jest agregowany.
agregacja specyfikacji	Typ specyfikacji agregacji	Obiekt `AggregateSpec`, który określa agregacje, które mają zostać wykonane w stosunku do zbioru wyników. Metoda AggregateSpec określa aliasy każdej agregacji, których można używać do pobierania wyników zagregowanych.

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(zapytanie)

Oblicza liczbę dokumentów w zbiorze wyników danego zapytania bez pobierania dokumentów.

Użycie tej funkcji do liczenia dokumentów jest wydajne, ponieważ dochodzi do liczenia ostatecznej liczby, a nie dokumentów danych. Ta funkcja może zliczać dokumenty w przypadkach, gdy zestaw wyników jest zbyt duży do pobrania w całości (tysiąc dokumentów).

Podpis:

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

Parametry

Parametr	Typ	Opis
zapytanie	Zapytanie<AppModelType, DbModelType>	Zapytanie, którego rozmiar zbioru wyników jest obliczany.

Zwroty:

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

obietnica, która zostanie rozstrzygnięta; liczbę można pobrać z zakresu snapshot.data().count, gdzie snapshot to wartość AggregateQuerySnapshot, którą realizuje zwrócona obietnica.

getDocuments(zapytanie)

Wykonuje zapytanie i zwraca wyniki jako QuerySnapshot.

Podpis:

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

Parametry

Parametr	Typ	Opis
zapytanie	Zapytanie<AppModelType, DbModelType>

Zwroty:

Obietnica<QuerySnapshot<AppModelType, DbModelType>>

Pole Promise, które zostanie rozstrzygnięte na podstawie wyników zapytania.

getDocumentsFromCache(zapytanie)

Wykonuje zapytanie i zwraca wyniki z pamięci podręcznej w postaci pliku QuerySnapshot. Zwraca pusty zestaw wyników, jeśli w pamięci podręcznej nie są obecnie przechowywane żadne dokumenty pasujące do zapytania.

Podpis:

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

Parametry

Parametr	Typ	Opis
zapytanie	Zapytanie<AppModelType, DbModelType>

Zwroty:

Obietnica<QuerySnapshot<AppModelType, DbModelType>>

Pole Promise, które zostanie rozstrzygnięte na podstawie wyników zapytania.

getDocumentsFromServer(zapytanie)

Wykonuje zapytanie i zwraca wyniki w postaci QuerySnapshot z serwera. Zwraca błąd, jeśli sieć jest niedostępna.

Podpis:

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

Parametry

Parametr	Typ	Opis
zapytanie	Zapytanie<AppModelType, DbModelType>

Zwroty:

Obietnica<QuerySnapshot<AppModelType, DbModelType>>

Pole Promise, które zostanie rozstrzygnięte na podstawie wyników zapytania.

onSnapshot(zapytanie; obserwator)

Dodaje detektor zdarzeń QuerySnapshot. Możesz przekazać indywidualne wywołania zwrotne onNext i onError lub przekazać pojedynczy obiekt obserwatora z wywołaniami zwrotnymi next i error. Detektor można anulować przez wywołanie funkcji, która jest zwracana po wywołaniu funkcji onSnapshot.

UWAGA: chociaż można zapewnić wywołanie zwrotne onCompletion, nie zostanie ono nigdy wywołane, ponieważ strumień zrzutów jest niekończący się.

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

Parametr	Typ	Opis
zapytanie	Zapytanie<AppModelType, DbModelType>	Zapytanie, które ma zostać odsłuchane.
obserwator	{ następny?: (zrzut: QuerySnapshot<AppModelType, DbModelType>) => void; ? (błąd: FirestoreError) => void; zakończono?: () => void;	Pojedynczy obiekt zawierający wywołania zwrotne `next` i `error`.

Zwroty:

Funkcja anulowania subskrypcji, którą można wywołać w celu anulowania detektora zrzutów.

onSnapshot(zapytanie, opcje, obserwator)

UWAGA: chociaż można zapewnić wywołanie zwrotne onCompletion, nie zostanie ono nigdy wywołane, ponieważ strumień zrzutów jest niekończący się.

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

Parametr	Typ	Opis
zapytanie	Zapytanie<AppModelType, DbModelType>	Zapytanie, które ma zostać odsłuchane.
opcje	SnapshotListenOptions	Opcje sterujące słuchaniem.
obserwator	{ następny?: (zrzut: QuerySnapshot<AppModelType, DbModelType>) => void; ? (błąd: FirestoreError) => void; zakończono?: () => void;	Pojedynczy obiekt zawierający wywołania zwrotne `next` i `error`.

Zwroty:

Funkcja anulowania subskrypcji, którą można wywołać w celu anulowania detektora zrzutów.

onSnapshot(zapytanie, onNext, onError, onComplete)

UWAGA: chociaż można zapewnić wywołanie zwrotne onCompletion, nie zostanie ono nigdy wywołane, ponieważ strumień zrzutów jest niekończący się.

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

Parametr	Typ	Opis
zapytanie	Zapytanie<AppModelType, DbModelType>	Zapytanie, które ma zostać odsłuchane.
onNext	(zrzut: QuerySnapshot<AppModelType, DbModelType>) => nieważne	Oddzwanianie wykonywane za każdym razem, gdy dostępny jest nowy numer `QuerySnapshot`.
onError	(błąd: FirestoreError) => nieważne	Wywołanie zwrotne w przypadku niepowodzenia lub anulowania nasłuchiwania. Nie będą już wykonywane żadne wywołania zwrotne.
po ukończeniu	() => nieważne	Można podać, ale nie zostanie wywołany, ponieważ strumienie nigdy się nie kończą.

Zwroty:

Funkcja anulowania subskrypcji, którą można wywołać w celu anulowania detektora zrzutów.

onSnapshot(zapytanie; opcje, onNext, onError, onComplete)

UWAGA: chociaż można zapewnić wywołanie zwrotne onCompletion, nie zostanie ono nigdy wywołane, ponieważ strumień zrzutów jest niekończący się.

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

Parametr	Typ	Opis
zapytanie	Zapytanie<AppModelType, DbModelType>	Zapytanie, które ma zostać odsłuchane.
opcje	SnapshotListenOptions	Opcje sterujące słuchaniem.
onNext	(zrzut: QuerySnapshot<AppModelType, DbModelType>) => nieważne	Oddzwanianie wykonywane za każdym razem, gdy dostępny jest nowy numer `QuerySnapshot`.
onError	(błąd: FirestoreError) => nieważne	Wywołanie zwrotne w przypadku niepowodzenia lub anulowania nasłuchiwania. Nie będą już wykonywane żadne wywołania zwrotne.
po ukończeniu	() => nieważne	Można podać, ale nie zostanie wywołany, ponieważ strumienie nigdy się nie kończą.

Zwroty:

Ograniczenie filtra QueryCompositeFilter

Funkcja anulowania subskrypcji, którą można wywołać w celu anulowania detektora zrzutów.

zapytanie(zapytanie, kompozytowy filtr, ograniczenia zapytań)

Tworzy nową, niezmienną instancję zapytania, która jest rozszerzona o uwzględnienie dodatkowych ograniczeń dotyczących zapytań.

Podpis:

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

Parametry

Parametr	Typ	Opis
zapytanie	Zapytanie<AppModelType, DbModelType>	Instancja Zapytanie, która ma być używana jako podstawa dla nowych ograniczeń.
Filtr złożony	Ograniczenie filtra QueryCompositeFilter	Wartość QueryCompositeFilterConstraint, która ma zostać zastosowana. Utwórz QueryCompositeFilterConstraint za pomocą funkcji and() lub or().
Ograniczenia zapytań	QueryNonFilterConstraint[]	Dodatkowe parametry QueryNonFilterConstraint do zastosowania (np. orderBy(), limit()).

Zwroty:

Zapytanie<AppModelType, DbModelType>

Wyjątki

jeśli żadnego z podanych ograniczeń dotyczących zapytań nie można połączyć z istniejącymi lub nowymi ograniczeniami.

zapytanie(zapytanie; ograniczenia zapytań)

Tworzy nową, niezmienną instancję zapytania, która jest rozszerzona o uwzględnienie dodatkowych ograniczeń dotyczących zapytań.

Podpis:

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

Parametry

Parametr	Typ	Opis
zapytanie	Zapytanie<AppModelType, DbModelType>	Instancja Zapytanie, która ma być używana jako podstawa dla nowych ograniczeń.
Ograniczenia zapytań	Ograniczenie zapytania[]	Lista ograniczeń zapytań, które mają zostać zastosowane.

Zwroty:

Zapytanie<AppModelType, DbModelType>

Wyjątki

jeśli żadnego z podanych ograniczeń dotyczących zapytań nie można połączyć z istniejącymi lub nowymi ograniczeniami.

function(queryConstraints, ...)

and(queryConstraints)

Tworzy nową funkcję QueryCompositeFilterConstraint, która łączy podane ograniczenia filtra. Filtr koniunkcyjny obejmuje dokument, jeśli spełnia wszystkie określone filtry.

Podpis:

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

Parametry

Parametr	Typ	Opis
Ograniczenia zapytań	QueryFilterConstraint[]	Opcjonalnie. Lista QueryFilterConstraints, dla której ma zostać przedstawiony spójnik. Należy je tworzyć z wywołaniami where(), or() lub and().

Zwroty:

Nowo utworzony QueryCompositeFilterConstraint.

or(queryConstraints)

Tworzy nową funkcję QueryCompositeFilterConstraint, która stanowi rozdzielenie podanych ograniczeń filtra. Filtr dystrybucji powoduje uwzględnienie dokumentu, jeśli spełnia on którykolwiek z podanych filtrów.

Podpis:

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

Parametry

Parametr	Typ	Opis
Ograniczenia zapytań	QueryFilterConstraint[]	Opcjonalnie. Lista QueryFilterConstraints, dla której mają zostać wykonane rozłączenia. Należy je tworzyć z wywołaniami where(), or() lub and().

Zwroty:

Ograniczenie filtra QueryCompositeFilter

Nowo utworzony QueryCompositeFilterConstraint.

funkcja(odwołanie, ...)

addDoc(odwołanie; dane)

Dodaj do określonego elementu CollectionReference nowy dokument z podanymi danymi, automatycznie przypisując mu identyfikator dokumentu.

Podpis:

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

Parametry

Parametr	Typ	Opis
odniesienie	CollectionReference<AppModelType, DbModelType>	Odwołanie do kolekcji, do której ma zostać dodany ten dokument.
dane	WithFieldValue<AppModelType>	Obiekt zawierający dane nowego dokumentu.

Zwroty:

Promise<DocumentReference<AppModelType, DbModelType>>

Działanie Promise zakończyło się ciągiem DocumentReference wskazującym nowo utworzony dokument po zapisaniu go w backendzie (nie zostanie on rozwiązany w trybie offline).

kolekcja(odwołanie; ścieżka; segmenty ścieżki)

Pobiera instancję CollectionReference odwołującą się do podkolekcji reference w określonej ścieżce względnej.

Podpis:

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

Parametry

Parametr	Typ	Opis
odniesienie	CollectionReference<AppModelType, DbModelType>	Odwołanie do kolekcji.
ścieżka	ciąg znaków	Rozdzielona ukośnikiem ścieżka do kolekcji.
segmenty ścieżki	ciąg znaków[]	Dodatkowe segmenty ścieżki do zastosowania w odniesieniu do pierwszego argumentu.

Zwroty:

CollectionReference<DocumentData, DocumentData>

Instancja CollectionReference.

Wyjątki

Końcowa ścieżka ma parzystą liczbę segmentów i nie wskazuje zbioru.

kolekcja(odwołanie; ścieżka; segmenty ścieżki)

Pobiera instancję CollectionReference odwołującą się do podkolekcji reference w określonej ścieżce względnej.

Podpis:

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

Parametry

Parametr	Typ	Opis
odniesienie	DocumentReference<AppModelType, DbModelType>	Odwołanie do dokumentu Firestore.
ścieżka	ciąg znaków	Rozdzielona ukośnikiem ścieżka do kolekcji.
segmenty ścieżki	ciąg znaków[]	Dodatkowe segmenty ścieżki, które zostaną zastosowane w stosunku do pierwszego argumentu.

Zwroty:

CollectionReference<DocumentData, DocumentData>

Instancja CollectionReference.

Wyjątki

Końcowa ścieżka ma parzystą liczbę segmentów i nie wskazuje zbioru.

deleteDoc(odwołanie)

Usuwa dokument, do którego odwołuje się określony element DocumentReference.

Podpis:

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

Parametry

Parametr	Typ	Opis
odniesienie	DocumentReference<AppModelType, DbModelType>	Odwołanie do dokumentu, który ma zostać usunięty.

Zwroty:

Obietnica<void>

Obietnica została zrealizowana, gdy dokument został usunięty z backendu (pamiętaj, że nie zostanie rozpoznana, gdy jesteś offline).

doc(odwołanie; ścieżka; segmenty ścieżek)

Pobiera wystąpienie DocumentReference odwołujące się do dokumentu z domeny reference w określonej ścieżce względnej. Jeśli nie podasz ścieżki, dla zwróconego zasobu DocumentReference zostanie użyty automatycznie wygenerowany unikalny identyfikator.

Podpis:

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

Parametry

Parametr	Typ	Opis
odniesienie	CollectionReference<AppModelType, DbModelType>	Odwołanie do kolekcji.
ścieżka	ciąg znaków	Ścieżka do dokumentu rozdzielana ukośnikami. Trzeba to pominąć, by użyć automatycznie generowanych identyfikatorów.
segmenty ścieżki	ciąg znaków[]	Dodatkowe segmenty ścieżki, które zostaną zastosowane w stosunku do pierwszego argumentu.

Zwroty:

DocumentReference<AppModelType, DbModelType>

Instancja DocumentReference.

Wyjątki

Jeśli końcowa ścieżka ma nieparzystą liczbę segmentów i nie wskazuje dokumentu.

doc(odwołanie; ścieżka; segmenty ścieżek)

Pobiera wystąpienie DocumentReference odwołujące się do dokumentu z domeny reference w określonej ścieżce względnej.

Podpis:

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

Parametry

Parametr	Typ	Opis
odniesienie	DocumentReference<AppModelType, DbModelType>	Odwołanie do dokumentu Firestore.
ścieżka	ciąg znaków	Ścieżka do dokumentu rozdzielana ukośnikami.
segmenty ścieżki	ciąg znaków[]	Dodatkowe segmenty ścieżki, które zostaną zastosowane w stosunku do pierwszego argumentu.

Zwroty:

DocumentReference<DocumentData, DocumentData>

Instancja DocumentReference.

Wyjątki

Jeśli końcowa ścieżka ma nieparzystą liczbę segmentów i nie wskazuje dokumentu.

getDoc(odwołanie)

Odczytuje dokument, do którego odwołuje się DocumentReference.

Podpis:

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

Parametry

Parametr	Typ	Opis
odniesienie	DocumentReference<AppModelType, DbModelType>	Odniesienie do dokumentu do pobrania.

Zwroty:

Promise<DocumentSnapshot<AppModelType, DbModelType>>

Obietnica rozwiązana za pomocą elementu DocumentSnapshot zawierającego bieżącą zawartość dokumentu.

getDocFromCache(odwołanie)

Odczytuje z pamięci podręcznej dokument, do którego odwołuje się ten element DocumentReference. Zwraca błąd, jeśli dokument nie jest obecnie w pamięci podręcznej.

Podpis:

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

Parametry

Parametr	Typ	Opis
odniesienie	DocumentReference<AppModelType, DbModelType>

Zwroty:

Promise<DocumentSnapshot<AppModelType, DbModelType>>

Pole Promise zostało rozpoznane jako DocumentSnapshot zawierające bieżącą zawartość dokumentu.

getDocFromServer(odwołanie)

Odczytuje z serwera dokument, do którego odwołuje się ten element DocumentReference. Zwraca błąd, jeśli sieć jest niedostępna.

Podpis:

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

Parametry

Parametr	Typ	Opis
odniesienie	DocumentReference<AppModelType, DbModelType>

Zwroty:

Promise<DocumentSnapshot<AppModelType, DbModelType>>

Pole Promise zostało rozpoznane jako DocumentSnapshot zawierające bieżącą zawartość dokumentu.

onSnapshot(odwołanie; obserwator)

Dodaje detektor zdarzeń DocumentSnapshot. Możesz przekazać indywidualne wywołania zwrotne onNext i onError lub przekazać pojedynczy obiekt obserwatora z wywołaniami zwrotnymi next i error.

UWAGA: chociaż można zapewnić wywołanie zwrotne onCompletion, nie zostanie ono nigdy wywołane, ponieważ strumień zrzutów jest niekończący się.

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

Parametr	Typ	Opis
odniesienie	DocumentReference<AppModelType, DbModelType>	Odwołanie do dokumentu, który ma zostać odsłuchany.
obserwator	{ następny?: (zrzut: DocumentSnapshot<AppModelType, DbModelType>) => void; ? (błąd: FirestoreError) => void; zakończono?: () => void;	Pojedynczy obiekt zawierający wywołania zwrotne `next` i `error`.

Zwroty:

Funkcja anulowania subskrypcji, którą można wywołać w celu anulowania detektora zrzutów.

onSnapshot(odwołanie; opcje; obserwator)

UWAGA: chociaż można zapewnić wywołanie zwrotne onCompletion, nie zostanie ono nigdy wywołane, ponieważ strumień zrzutów jest niekończący się.

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

Parametr	Typ	Opis
odniesienie	DocumentReference<AppModelType, DbModelType>	Odwołanie do dokumentu, który ma zostać odsłuchany.
opcje	SnapshotListenOptions	Opcje sterujące słuchaniem.
obserwator	{ następny?: (zrzut: DocumentSnapshot<AppModelType, DbModelType>) => void; ? (błąd: FirestoreError) => void; zakończono?: () => void;	Pojedynczy obiekt zawierający wywołania zwrotne `next` i `error`.

Zwroty:

Funkcja anulowania subskrypcji, którą można wywołać w celu anulowania detektora zrzutów.

onSnapshot(odwołanie; onNext, onError, onComplete)

UWAGA: chociaż można zapewnić wywołanie zwrotne onCompletion, nie zostanie ono nigdy wywołane, ponieważ strumień zrzutów jest niekończący się.

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

Parametr	Typ	Opis
odniesienie	DocumentReference<AppModelType, DbModelType>	Odwołanie do dokumentu, który ma zostać odsłuchany.
onNext	(zrzut: DocumentSnapshot<AppModelType, DbModelType>) => nieważne	Oddzwanianie wykonywane za każdym razem, gdy dostępny jest nowy numer `DocumentSnapshot`.
onError	(błąd: FirestoreError) => nieważne	Wywołanie zwrotne w przypadku niepowodzenia lub anulowania nasłuchiwania. Nie będą już wykonywane żadne wywołania zwrotne.
po ukończeniu	() => nieważne	Można podać, ale nie zostanie wywołany, ponieważ strumienie nigdy się nie kończą.

Zwroty:

Funkcja anulowania subskrypcji, którą można wywołać w celu anulowania detektora zrzutów.

onSnapshot(odwołanie; opcje, onNext, onError, onComplete)

UWAGA: chociaż można zapewnić wywołanie zwrotne onCompletion, nie zostanie ono nigdy wywołane, ponieważ strumień zrzutów jest niekończący się.

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

Parametr	Typ	Opis
odniesienie	DocumentReference<AppModelType, DbModelType>	Odwołanie do dokumentu, który ma zostać odsłuchany.
opcje	SnapshotListenOptions	Opcje sterujące słuchaniem.
onNext	(zrzut: DocumentSnapshot<AppModelType, DbModelType>) => nieważne	Oddzwanianie wykonywane za każdym razem, gdy dostępny jest nowy numer `DocumentSnapshot`.
onError	(błąd: FirestoreError) => nieważne	Wywołanie zwrotne w przypadku niepowodzenia lub anulowania nasłuchiwania. Nie będą już wykonywane żadne wywołania zwrotne.
po ukończeniu	() => nieważne	Można podać, ale nie zostanie wywołany, ponieważ strumienie nigdy się nie kończą.

Zwroty:

MemoryLruGarbageCollector

Funkcja anulowania subskrypcji, którą można wywołać w celu anulowania detektora zrzutów.

setDoc(odwołanie; dane)

Zapisuje informacje w dokumencie, do którego odwołuje się ten DocumentReference. Jeśli dokument jeszcze nie istnieje, zostanie utworzony.

Podpis:

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

Parametry

Parametr	Typ	Opis
odniesienie	DocumentReference<AppModelType, DbModelType>	Odwołanie do dokumentu do zapisania.
dane	WithFieldValue<AppModelType>	Mapa pól i wartości dokumentu.

Zwroty:

Obietnica<void>

Pole Promise zostało rozwiązane po zapisaniu danych w backendzie (pamiętaj, że nie zostanie rozpoznane, gdy jesteś offline).

setDoc(odwołanie; dane; opcje)

Zapisuje dane w dokumencie, do którego odwołuje się określony element DocumentReference. Jeśli dokument jeszcze nie istnieje, zostanie utworzony. Jeśli podasz merge lub mergeFields, podane dane zostaną scalone w istniejący dokument.

Podpis:

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

Parametry

Parametr	Typ	Opis
odniesienie	DocumentReference<AppModelType, DbModelType>	Odwołanie do dokumentu do zapisania.
dane	częściowo z wartością pola<AppModelType>	Mapa pól i wartości dokumentu.
opcje	SetOptions	Obiekt do skonfigurowania zachowania zestawu.

Zwroty:

Obietnica<void>

Obietnica została zrealizowana po zapisaniu danych w backendzie (pamiętaj, że nie zostanie rozpoznana, gdy jesteś offline).

updateDoc(odwołanie; dane)

Aktualizuje pola w dokumencie, do którego odwołuje się podany element DocumentReference. Aktualizacja się nie powiedzie, jeśli zostanie zastosowana do nieistniejącego dokumentu.

Podpis:

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

Parametry

Parametr	Typ	Opis
odniesienie	DocumentReference<AppModelType, DbModelType>	Odwołanie do dokumentu do zaktualizowania.
dane	UpdateData<DbModelType>	Obiekt zawierający pola i wartości do zaktualizowania dokumentu. Pola mogą zawierać kropki, aby odwoływać się do zagnieżdżonych pól w dokumencie.

Zwroty:

Obietnica<void>

Pole Promise zostało rozwiązane po zapisaniu danych w backendzie (pamiętaj, że nie zostanie rozpoznane, gdy jesteś offline).

updateDoc(odwołanie; pole; wartość; moreFieldsAndValues)

Aktualizuje pola w dokumencie, do którego odwołuje się podany DocumentReference. Aktualizacja zakończy się niepowodzeniem, jeśli zostanie zastosowana do nieistniejącego dokumentu.

Zagnieżdżone pola można aktualizować, podając rozdzielone kropkami ciągi ścieżek pól lub obiekty FieldPath.

Podpis:

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

Parametry

Parametr	Typ	Opis
odniesienie	DocumentReference<AppModelType, DbModelType>	Odwołanie do dokumentu do zaktualizowania.
pole	ciąg znaków \| FieldPath	Pierwsze pole do zaktualizowania.
wartość	nieznany	Pierwsza wartość.
więcej pól i wartości	nieznana[]	Dodatkowe pary klucz-wartość.

Zwroty:

Obietnica<void>

Pole Promise zostało rozwiązane po zapisaniu danych w backendzie (pamiętaj, że nie zostanie rozpoznane, gdy jesteś offline).

funkcja(ustawienia, ...)

storageLocalCache(ustawienia)

Tworzy instancję MemoryLocalCache. Możesz ustawić dla instancji wartość FirestoreSettings.cache, aby informować pakiet SDK, której warstwy pamięci podręcznej ma użyć.

Podpis:

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

Parametry

Parametr	Typ	Opis
ustawienia	MemoryCacheSettings (Ustawienia MemoryCacheSettings)

Zwroty:

MemoryLocalCache

PamięciLruGarbageCollector(ustawienia)

Tworzy instancję MemoryLruGarbageCollector.

Rozmiar docelowy można określić w parametrze ustawienia. Kolektor zacznie usuwać dokumenty, gdy rozmiar pamięci podręcznej przekroczy podany rozmiar. Domyślny rozmiar pamięci podręcznej to 40 MB (40 × 1024 × 1024 bajty).

Podpis:

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

Parametry

Parametr	Typ	Opis
ustawienia	{CacheSizeBytes?: number;

Zwroty:

trwała pamięć podręczna(ustawienia)

Tworzy instancję PersistentLocalCache. Możesz ustawić dla instancji wartość FirestoreSettings.cache, aby informować pakiet SDK, której warstwy pamięci podręcznej ma użyć.

stałej pamięci podręcznej nie można używać w środowisku Node.js.

Podpis:

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

Parametry

Parametr	Typ	Opis
ustawienia	PersistentCacheSettings,

Zwroty:

PersistentLocalCache

StabilSingleTabManager(ustawienia)

Tworzy instancję PersistentSingleTabManager.

Podpis:

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

Parametry

Parametr	Typ	Opis
ustawienia	PersistentSingleTabManagerSettings \| nie zdefiniowano	Konfiguruje utworzony menedżer kart.

Zwroty:

PersistentSingleTabManager

funkcja(zrzut; ...)

endAt(zrzut)

Tworzy obiekt QueryEndAtConstraint, który zmienia zbiór wyników tak, aby kończył się na podanym dokumencie (włącznie). Pozycja końcowa zależy od kolejności zapytania. Dokument musi zawierać wszystkie pola określone w polu orderBy zapytania.

Podpis:

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

Parametry

Parametr	Typ	Opis
zrzut	DocumentSnapshot<AppModelType, DbModelType>	Migawka dokumentu, na której ma się kończyć.

Zwroty:

Element QueryEndAtConstraint przekazywany do funkcji query()

endPrzed(zrzut)

Tworzy obiekt QueryEndAtConstraint, który zmienia (z wyłączeniem) wartość ustawioną na koniec przed podanym dokumentem. Pozycja końcowa zależy od kolejności zapytania. Dokument musi zawierać wszystkie pola określone w polu orderBy zapytania.

Podpis:

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

Parametry

Parametr	Typ	Opis
zrzut	DocumentSnapshot<AppModelType, DbModelType>	Migawka dokumentu, która ma się zakończyć wcześniej.

Zwroty:

Element QueryEndAtConstraint przekazywany do funkcji query()

startAfter(zrzut)

Tworzy obiekt QueryStartAtConstraint, który zmienia zbiór wyników tak, aby rozpoczynał się po dostarczonym dokumencie (z wyłączeniem). Pozycja początkowa zależy od kolejności zapytania. Dokument musi zawierać wszystkie pola określone w polu orderBy zapytania.

Podpis:

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

Parametry

Parametr	Typ	Opis
zrzut	DocumentSnapshot<AppModelType, DbModelType>	Migawka dokumentu, po której ma nastąpić uruchomienie.

Zwroty:

Element QueryStartAtConstraint przekazywany do funkcji query()

startAt(zrzut)

Tworzy obiekt QueryStartAtConstraint, który modyfikuje zbiór wyników tak, aby rozpoczynał się od podanego dokumentu (włącznie). Pozycja początkowa zależy od kolejności zapytania. Dokument musi zawierać wszystkie pola wymienione w polu orderBy tego zapytania.

Podpis:

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

Parametry

Parametr	Typ	Opis
zrzut	DocumentSnapshot<AppModelType, DbModelType>	Migawka dokumentu, od której ma się zaczynać.

Zwroty: