@firebase/firestore/lite

Funkcje

Zajęcia

Interfejsy

Wpisz aliasy

funkcja (aplikacja, ...)

pobierzFirestore(aplikacja)

Zwraca istniejącą domyślną instancję Firestore powiązaną z dostarczoną aplikacją FirebaseApp . Jeśli nie istnieje żadna instancja, inicjuje nową instancję z ustawieniami domyślnymi.

Podpis:

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

Parametry

Zwroty:

Sklep z ogniem

Instancja Firestore dostarczonej aplikacji.

getFirestore(aplikacja, identyfikator bazy danych)

Ten interfejs API jest udostępniany jako wersja zapoznawcza dla programistów i może ulec zmianie w zależności od otrzymanych opinii. Nie używaj tego interfejsu API w środowisku produkcyjnym.

Zwraca istniejącą instancję Firestore powiązaną z podaną aplikacją 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:

Sklep z ogniem

Instancja Firestore dostarczonej aplikacji.

zainicjujFirestore(aplikacja, ustawienia)

Inicjuje nową instancję Cloud Firestore z podanymi ustawieniami. Można wywołać tylko przed innymi funkcjami, w tym getFirestore() . Jeśli ustawienia niestandardowe są puste, ta funkcja jest równoważna wywołaniu metody getFirestore() .

Podpis:

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

Parametry

Zwroty:

Sklep z ogniem

Nowo zainicjowana instancja Firestore .

zainicjujFirestore(aplikacja, ustawienia, identyfikator bazy danych)

Ten interfejs API jest udostępniany jako wersja zapoznawcza dla programistów i może ulec zmianie w zależności od otrzymanych opinii. Nie używaj tego interfejsu API w środowisku produkcyjnym.

Inicjuje nową instancję Cloud Firestore z podanymi ustawieniami. Można wywołać tylko przed innymi funkcjami, w tym getFirestore() . Jeśli ustawienia niestandardowe są puste, ta funkcja jest równoważna wywołaniu funkcji getFirestore() .

Podpis:

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

Parametry

Zwroty:

Sklep z ogniem

Nowo zainicjowana instancja Firestore .

funkcja (firestore, ...)

kolekcja (firestore, ścieżka, pathSegments)

Pobiera wystąpienie CollectionReference , które odwołuje się do kolekcji w określonej ścieżce bezwzględnej.

Podpis:

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

Parametry

Zwroty:

KolekcjaReferencja < Dane dokumentu , Dane dokumentu >

Instancja CollectionReference .

Wyjątki

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

kolekcjaGrupa(firestore, identyfikator kolekcji)

Tworzy i zwraca nową instancję Query , która zawiera wszystkie dokumenty w bazie danych zawarte w kolekcji lub podkolekcji o podanym collectionId .

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

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.

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.

zakończyć (Firestore)

Kończy dostarczoną instancję Firestore .

Po wywołaniu terminate() można zastosować tylko funkcje clearIndexedDbPersistence() . Każda inna funkcja rzuci FirestoreError . Zakończenie nie anuluje żadnych oczekujących zapisów, a wszelkie obietnice, które oczekują na odpowiedź serwera, nie zostaną rozwiązane.

Aby zrestartować po wypowiedzeniu, utwórz nową instancję Firestore z getfirestore () .

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.

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.

Wynik tych zapisów zostanie odzwierciedlony tylko w odczytach dokumentów, które występują po zwróconej obietnicy. Jeśli klient jest w trybie offline, zapis zawiedzie. Jeśli chcesz zobaczyć lokalne modyfikacje lub zapisy bufora, dopóki klient nie będzie online, skorzystaj z pełnego SDK Firestore.

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 pola

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:

Sklep z ogniem

Instancja Firestore dostarczonej aplikacji.

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ą 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:

Sklep z ogniem

Instancja Firestore dostarczonej aplikacji.

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. Jeśli modyfikowane pole nie jest jeszcze tablicą, zostanie zastąpiona pustą tablicą.

Podpis:

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

Parametry

Zwroty:

Wartość pola

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

Arrayunion (elementy)

Zwraca specjalną wartość, której można użyć z setDoc () lub aktualizateC () , która informuje serwer do połączenia danych elementów z dowolną wartością tablicy, która już istnieje na serwerze. Każdy określony element, który już nie istnieje w tablicy, zostanie dodany do końca. Jeśli modyfikowane pole nie jest jeszcze tablicą, zostanie zastąpiona tablicą zawierającą dokładnie określone elementy.

Podpis:

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

Parametry

Zwroty:

Wartość pola

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

funkcja (pole, ...)

średnia (pole)

Utwórz obiekt Aggregatefield, który można użyć do obliczenia średniej określonego pola w zakresie dokumentów w zestawie wyników zapytania.

Podpis:

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

Parametry

Zwroty:

Aggregatefield <liczba | null>

suma (pole)

Utwórz obiekt AggregateField, którego można użyć do obliczenia suma określonego pola w zakresie dokumentów w zestawie wyników zapytania.

Podpis:

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

Parametry

Zwroty:

Aggregatefield <numer>

funkcja (fieldPath, ...)

Orderby (FieldPath, DirectStr)

Tworzy QueryOrderByConstraint , który sortuje wynik zapytania według określonego pola, opcjonalnie w kolejności malejącej zamiast wznoszenia.

Podpis:

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

Parametry

Zwroty:

QueryorderbyConstraint

Utworzono QueryOrderByConstraint .

gdzie (FieldPath, OPSTR, wartość)

Tworzy queryfieldFilterConstraint , który egzekwuje, że dokumenty muszą zawierać określone pole i że wartość powinna spełniać dostarczone ograniczenie relacji.

Podpis:

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

Parametry

Zwroty:

QueryfieldFilterConstraint

Utworzono QueryfieldFilterConstraint .

funkcja (wartości field, ...)

endat (wartości terenowe)

Tworzy zapisy , który modyfikuje wyniki ustawione na dostarczone pola względem kolejności zapytania. Kolejność wartości pola musi być zgodna z kolejnością kolejności według klauzul zapytania.

Podpis:

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

Parametry

Zwroty:

QueryendatConstraint

Zamknięcie QueryendatConstraint do query()

endBefore (FieldValues)

Tworzy zapisy , które modyfikuje ustawione wyniki, aby zakończyć się przed dostarczonymi pola względem kolejności zapytania. Kolejność wartości pola musi być zgodna z kolejnością kolejności według klauzul zapytania.

Podpis:

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

Parametry

Zwroty:

QueryendatConstraint

Zamknięcie QueryendatConstraint do query()

startufter (wartości terenowe)

Tworzy zapisy QueryStartatConstraint , które modyfikuje zestaw wyników, aby rozpocząć się po dostarczonych polach w stosunku do kolejności zapytania. Kolejność wartości pola musi być zgodna z kolejnością kolejności według klauzul zapytania.

Podpis:

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

Parametry

Zwroty:

QueryStartatConstraint

QueryStartatConstraint do przejścia do query()

startat (wartości terenowe)

Tworzy zapis QueryStartatConstraint , który modyfikuje zestaw wyników, aby rozpocząć się na dostarczonych polach w stosunku do kolejności zapytania. Kolejność wartości pola musi być zgodna z kolejnością kolejności według klauzul zapytania.

Podpis:

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

Parametry

Zwroty:

QueryStartatConstraint

QueryStartatConstraint do przejścia do query() .

funkcja (po lewej, ...)

AggregateFieldEqual (po lewej, po prawej)

Porównuje dwa „agregatefield „Instancje równości.

Podpis:

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

Parametry

Zwroty:

wartość logiczna

AggregateQuerySnapshotequal (po lewej, po prawej)

Porównuje dwie instancje AggregateQuerySnapshot dla równości.

Dwa instancje AggregateQuerySnapshot są uważane za „równe”, jeżeli mają podstawowe zapytania, które porównują równe, i 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

Zwroty:

wartość logiczna

true , jeśli obiekty są „równe”, jak zdefiniowano powyżej, lub false w inny sposób.

Quersequal (po lewej, po prawej)

Zwraca prawdziwie, jeśli podane zapytania wskazują na tę samą kolekcję i zastosują te same ograniczenia.

Podpis:

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

Parametry

Zwroty:

wartość logiczna

To prawda, jeśli odniesienia wskazują do tej samej lokalizacji w tej samej bazie danych Firestore.

Refeckiega (po lewej, po prawej)

Zwraca prawdziwie, jeśli podane odniesienia 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

Zwroty:

wartość logiczna

To prawda, jeśli odniesienia wskazują do tej samej lokalizacji w tej samej bazie danych Firestore.

Snapshotequal (po lewej, po prawej)

Zwraca prawdziwie, jeśli dostarczone migawki 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

Zwroty:

wartość logiczna

To prawda, że ​​migawki są równe.

funkcja (limit, ...)

limit (limit)

Tworzy QueryLimitConstraint , który zwraca tylko pierwsze dopasowane dokumenty.

Podpis:

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

Parametry

Zwroty:

QueryLimitconstraint

Utworzono QueryLimitConstraint .

limitolast (limit)

Tworzy QueryLimitConstraint , który zwraca tylko ostatnie dopasowane dokumenty.

Musisz określić przynajmniej jedną klauzulę orderBy dla zapytań limitToLast , w przeciwnym razie wyjątek zostanie rzucony podczas wykonywania.

Podpis:

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

Parametry

Zwroty:

QueryLimitconstraint

Utworzono QueryLimitConstraint .

funkcja (loglevel, ...)

setloglevel (loglevel)

Ustawia gadatość dzienników Cloud Firestore (debugowanie, błąd lub ciche).

Podpis:

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

Parametry

Zwroty:

próżnia

funkcja (n, ...)

przyrost (n)

Zwraca specjalną wartość, której można użyć z setDoc () lub aktualizateC () , która informuje serwer, aby zwiększył bieżącą wartość pola o daną wartość.

Jeśli albo operand lub bieżąca wartość pola wykorzystuje precyzję zmiennoprzecinkowej, cała arytmetyka podąża za semantyką IEEE 754. Jeśli obie wartości są liczbami całkowite, wartości poza bezpiecznym zakresem liczb JavaScript ( Number.MIN_SAFE_INTEGER do Number.MAX_SAFE_INTEGER ) podlegają również utracie precyzyjnej. Ponadto, po przetworzeniu przez backend Firestore, wszystkie operacje całkowitowe są ograniczone między -2^63 a 2^63-1.

Jeśli bieżąca wartość pola nie jest number typu , lub jeśli pole jeszcze nie istnieje, transformacja ustawia pole na daną wartość.

Podpis:

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

Parametry

Zwroty:

Wartość pola

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

funkcja(zapytanie, ...)

getAggregate(zapytanie, zagregowanaSpec)

Oblicza określone agregacje dotyczące dokumentów w zestawie wyników danego zapytania bez faktycznego pobierania dokumentów.

Korzystanie z tej funkcji do wykonywania agregacji jest wydajne, ponieważ pobierane są tylko ostateczne wartości agregacji, a nie dane dokumentów. Ta funkcja może wykonywać agregacje dokumentów w przypadkach, w których zestaw wyników jest zbyt duży do pobrania (tysiące dokumentów).

Podpis:

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

Parametry

Zwroty:

Obiecaj < agregateQuerySnapshot <AggregatesPectpype, AppModelType, DBModelType >>

Przykład

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

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

getCount (zapytanie)

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

Korzystanie z tej funkcji do zliczenia dokumentów jest wydajne, ponieważ pobierane są tylko liczba ostateczna, a nie dane dokumentów. Ta funkcja może policzyć dokumenty w przypadkach, w których zestaw wyników jest zbyt duży do całkowitego pobrania (tysiące dokumentów).

Podpis:

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

Parametry

Zwroty:

Obiecaj < agregateQuerySnapshot <{Count: Aggregatefield <liczba>; }, AppModelType, dbModelType >>

Obietnica, która zostanie rozwiązana z hrabiego; Liczba można pobrać z snapshot.data().count , gdzie snapshot jest AggregateQuerySnapshot , do którego powrócona obietnica ustępuje.

getdocs (zapytanie)

Wykonuje zapytanie i zwraca wyniki jako zapytanie .

Wszystkie zapytania są wykonywane bezpośrednio przez serwer, nawet jeśli zapytanie zostało wcześniej wykonane. Ostatnie modyfikacje znajdują odzwierciedlenie tylko w odzyskanych wynikach, jeśli zostały już zastosowane przez backend. Jeśli klient jest offline, operacja się nie powiedzie. Aby zobaczyć wcześniej buforowane wyniki i lokalne modyfikacje, użyj pełnego SDK Firestore.

Podpis:

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

Parametry

Zwroty:

Obiecaj < queryysnapshot <AppModelType, dbModelType >>

Obietnica, która zostanie rozwiązana w wynikach zapytania.

Zapytanie (zapytanie, CompositeFilter, QueryConstraints)

Tworzy nowy niezmienny przykład zapytania , który jest rozszerzony o dodatkowe ograniczenia zapytania.

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

Jeżeli którekolwiek z dostarczonych ograniczeń zapytania nie można połączyć z istniejącymi lub nowymi ograniczeniami.

Zapytanie (zapytanie, QueryConstraints)

Tworzy nowy niezmienny przykład zapytania , który jest rozszerzony o dodatkowe ograniczenia zapytania.

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

Jeżeli którekolwiek z dostarczonych ograniczeń zapytania nie można połączyć z istniejącymi lub nowymi ograniczeniami.

funkcja (QueryConstraints, ...)

i (QueryConstraints)

Tworzy nowy QueryCompOSEFILTERCONSTRARCATRING , który jest połączeniem danych ograniczeń filtra. Filtr koniunkcyjny zawiera dokument, jeśli spełnia wszystkie podane filtry.

Podpis:

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

Parametry

Zwroty:

QueryCompositeFilterConstraint

Nowo utworzony QueryCompositeFilterConstraint .

lub (QueryConstraints)

Tworzy nowy QueryCompOSEFILTERCONSTRARCATRING , który jest rozłączeniem danych ograniczeń filtra. Filtr Disjunction zawiera dokument, jeżeli spełnia którykolwiek z podanych filtrów.

Podpis:

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

Parametry

Zwroty:

QueryCompositeFilterConstraint

Nowo utworzony QueryCompositeFilterConstraint .

funkcja (odniesienie, ...)

addDoc (odniesienie, dane)

Dodaj nowy dokument do określonego CollectionReference za pomocą podanych danych, automatycznie przypisując go identyfikator dokumentu.

Wynik tego zapisu zostanie odzwierciedlony tylko w odczytach dokumentów, które występują po zwróconej obietnicy. Jeśli klient jest w trybie offline, zapis zawiedzie. Jeśli chcesz zobaczyć lokalne modyfikacje lub zapisy bufora, dopóki klient nie będzie online, skorzystaj z pełnego SDK Firestore.

Podpis:

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

Parametry

Zwroty:

Obietnica < dokumentReference <AppModelType, dbModelType >>

Promise rozwiązana wraz z DocumentReference wskazującym na nowo utworzony dokument po napisaniu go na backend.

Wyjątki

Błąd - jeśli podane dane wejściowe nie jest prawidłowym dokumentem Firestore.

Kolekcja (odniesienie, ścieżka, Pathsegments)

Otrzymuje instancję CollectionReference , która odnosi się do podkolisku reference na 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

Zwroty:

CollectionReference < DocumentData , DocumentData >

Instancja CollectionReference .

Wyjątki

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

Kolekcja (odniesienie, ścieżka, Pathsegments)

Otrzymuje instancję CollectionReference , która odnosi się do podkolisku reference na 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

Zwroty:

CollectionReference < DocumentData , DocumentData >

Instancja CollectionReference .

Wyjątki

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

deleTEDOC (odniesienie)

Usuwa dokument, o którym mowa w określonym DocumentReference .

Usunięcie zostanie odzwierciedlone tylko w odczytach dokumentów, które wystąpią po zwróconej obietnicy. Jeśli klient jest offline, Usuń się nie powiedzie. Jeśli chcesz zobaczyć lokalne modyfikacje lub zapisy bufora, dopóki klient nie będzie online, skorzystaj z pełnego SDK Firestore.

Podpis:

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

Parametry

Zwroty:

Obiecaj <Void>

Promise rozwiązana po pomyślnym usunięciu dokumentu z zaplecza.

DOC (odniesienie, ścieżka, Pathsegments)

Otrzymuje instancję DocumentReference , która odnosi się do dokumentu w ramach reference na określonej ścieżce względnej. Jeśli nie zostanie określona ścieżka, do zwróconego DocumentReference zostanie wykorzystany automatycznie unikalny identyfikator .

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>

Instancja DocumentReference .

Wyjątki

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

DOC (odniesienie, ścieżka, Pathsegments)

Otrzymuje instancję DocumentReference , która odnosi się do dokumentu w ramach reference na 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

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.

getDoc (odniesienie)

Odczytuje dokument, o którym mowa w określonym odniesieniu do dokumentu.

Wszystkie dokumenty są pobierane bezpośrednio z serwera, nawet jeśli dokument był wcześniej odczytany lub zmodyfikowany. Ostatnie modyfikacje znajdują odzwierciedlenie tylko w odzyskanych DocumentSnapshot , jeśli zostały już zastosowane przez backend. Jeśli klient jest w trybie offline, odczyt się nie powiedzie. Jeśli lubisz korzystać z buforowania lub zobaczyć lokalne modyfikacje, skorzystaj z pełnego SDK Firestore.

Podpis:

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

Parametry

Zwroty:

Obiecaj < DocumentsNapshot <AppModelType, dbModelType >>

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

setDoc (odniesienie, dane)

Zapisuje do dokumentu, o którym mowa określone DocumentReference . Jeśli dokument jeszcze nie istnieje, zostanie utworzony.

Wynik tego zapisu zostanie odzwierciedlony tylko w odczytach dokumentów, które występują po zwróconej obietnicy. Jeśli klient jest w trybie offline, zapis zawiedzie. Jeśli chcesz zobaczyć lokalne modyfikacje lub zapisy bufora, dopóki klient nie będzie online, skorzystaj z pełnego SDK Firestore.

Podpis:

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

Parametry

Zwroty:

Obiecaj <Void>

Promise rozwiązana po pomyślnym zapisaniu danych na zapleczu.

Wyjątki

Błąd - jeśli podane dane wejściowe nie jest prawidłowym dokumentem Firestore.

setDoc (odniesienie, dane, opcje)

Zapisuje do dokumentu, o którym mowa określone DocumentReference . Jeśli dokument jeszcze nie istnieje, zostanie utworzony. Jeśli zapewniasz merge lub mergeFields , Dostarczone dane można połączyć z istniejącym dokumentem.

Wynik tego zapisu zostanie odzwierciedlony tylko w odczytach dokumentów, które występują po zwróconej obietnicy. Jeśli klient jest w trybie offline, zapis zawiedzie. Jeśli chcesz zobaczyć lokalne modyfikacje lub zapisy bufora, dopóki klient nie będzie online, skorzystaj z pełnego SDK Firestore.

Podpis:

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

Parametry

Zwroty:

Obiecaj <Void>

Promise rozwiązana po pomyślnym zapisaniu danych na zapleczu.

Wyjątki

Błąd - jeśli podane dane wejściowe nie jest prawidłowym dokumentem Firestore.

UpdateC (odniesienie, dane)

Aktualizuje pola w dokumencie, o którym mowa w określonym DocumentReference . Aktualizacja nie powiedzie się, jeśli zostanie zastosowana do dokumentu, który nie istnieje.

Wynik tej aktualizacji zostanie odzwierciedlony tylko w odczytach dokumentów, które występują po zwróconej obietnicy. Jeśli klient jest w trybie offline, aktualizacja nie powiedzie się. Jeśli chcesz zobaczyć lokalne modyfikacje lub zapisy bufora, dopóki klient nie będzie online, skorzystaj z pełnego SDK Firestore.

Podpis:

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

Parametry

Zwroty:

Obiecaj <Void>

Promise rozwiązana po pomyślnym zapisaniu danych na zapleczu.

Wyjątki

Błąd - jeśli dostarczone dane wejściowe nie jest prawidłowymi danymi Firestore.

UpdateC (odniesienie, pole, wartość, MorefieldsandValues)

Aktualizacje pola w dokumencie, o którym mowa określone DocumentReference Aktualizacja nie powiedzie się, jeśli zostanie zastosowana do dokumentu, który nie istnieje.

Pola zagnieżdżone można aktualizować, zapewniając rozdzielone kropki ciągnie ścieżki polowej lub podając obiekty FieldPath .

Wynik tej aktualizacji zostanie odzwierciedlony tylko w odczytach dokumentów, które występują po zwróconej obietnicy. Jeśli klient jest w trybie offline, aktualizacja nie powiedzie się. Jeśli chcesz zobaczyć lokalne modyfikacje lub zapisy bufora, dopóki klient nie będzie online, skorzystaj z pełnego SDK Firestore.

Podpis:

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

Parametry

Zwroty:

Obiecaj <Void>

Promise rozwiązana po pomyślnym zapisaniu danych na zapleczu.

Wyjątki

Błąd - jeśli dostarczone dane wejściowe nie jest prawidłowymi danymi Firestore.

funkcja (migawka, ...)

endat (migawka)

Tworzy zapisy QueryendatConstraint , które modyfikuje ustawiony wyniki, aby zakończyć się w dostarczonym dokumencie (włącznie). Pozycja końcowa jest w stosunku do kolejności zapytania. Dokument musi zawierać wszystkie pola podane w kolejności zapytania.

Podpis:

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

Parametry

Zwroty:

QueryendatConstraint

Zamknięcie QueryendatConstraint do query()

EndBefore (migawka)

Tworzy zapisy QueryendatConstraint , które modyfikuje ustawiony wyniki, aby zakończyć się przed podany dokument (wyłączny). Pozycja końcowa jest w stosunku do kolejności zapytania. Dokument musi zawierać wszystkie pola podane w kolejności zapytania.

Podpis:

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

Parametry

Zwroty:

QueryendatConstraint

Zamknięcie QueryendatConstraint do query()

Startafter (migawka)

Tworzy QueryStartatConstraint , który modyfikuje zestaw wyników, aby rozpocząć się po podanym dokumencie (wyłącznym). Pozycja początkowa jest względna kolejności zapytania. Dokument musi zawierać wszystkie pola podane w kolejności zapytania.

Podpis:

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

Parametry

Zwroty:

QueryStartatConstraint

QueryStartatConstraint do przejścia do query()

startat (migawka)

Tworzy equeryStartatConstraint , który modyfikuje zestaw wyników, aby rozpocząć się w dostarczonym dokumencie (włącznie). Pozycja początkowa jest względna kolejności zapytania. Dokument musi zawierać wszystkie pola podane w orderBy tego zapytania.

Podpis:

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

Parametry

Zwroty:

QueryStartatConstraint

QueryStartatConstraint do przejścia do query() .

Addprefixtokeys

Zwraca nową mapę, w której każdy klucz jest prefiksowany z zewnętrznym kluczem dołączonym do kropki.

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

Związek wszystkich typów AggregateField , które są wspierane przez Firestore.

Podpis:

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

AggregatesPecdata

Typ, którego klucze są pobierane z AggregateSpec i których wartości są wynikiem agregacji wykonanej przez odpowiednią AggregateField z AggregateSpec wejściowych .

Podpis:

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

AggregateType

Typ Unii reprezentujący typ agregatu do wykonania.

Podpis:

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

ChildUpdatefields

Pomocnik do obliczania zagnieżdżonych pól dla danego typu T1. Jest to potrzebne do dystrybucji typów związków, takich jak undefined | {...} (zdarza się dla opcjonalnych rekwizytów) lub {a: A} | {b: B} .

W tym przypadku V służy do Record związków T[K] , ponieważ T[K] jest oceniane jako wyrażenie i nie jest rozmieszczone.

Zobacz https://www.typescriptlang.org/docs/handbook/advanced-types.html#distribctive-onditional-types

Podpis:

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

FIRESTOREERRORCODE

Zestaw kodów stanu Firestore. Kody są takie same na tych ujawnionych przez GRPC tutaj: https://github.com/grpc/grpc/blob/master/doc/statuscodes.md

Możliwe wartości: - „anulowane”: Operacja została anulowana (zwykle przez dzwoniącego). - „Nieznany”: Nieznany błąd lub błąd z innej domeny błędu. - „Nieprawidłowy argument”: Klient określił nieprawidłowy argument. Należy zauważyć, że różni się to od „nieudanej prefondcji”. „Nieprawidłowy argument” wskazuje argumenty, które są problematyczne, niezależnie od stanu systemu (np. Nieprawidłowa nazwa pola). - „Termin-exed”: termin wygasł przed zakończeniem operacji. W przypadku operacji, które zmieniają stan systemu, błąd ten może zostać zwrócony, nawet jeśli operacja zakończyła się pomyślnie. Na przykład pomyślna odpowiedź serwera mogła być opóźniona wystarczająco długo, aby termin wygasł. - „Niestał”: nie znaleziono żądanego dokumentu. - „Just-Existists”: jakiś dokument, który próbowaliśmy już utworzyć. - „Zezwolenie”: dzwoniący nie ma zgody na wykonanie określonej operacji. -„Eksploracja zasobów”: Niektóre zasoby zostały wyczerpane, być może kwota dla użytkownika, a może cały system plików nie jest w przestrzeni. - „Niepowodzenie prefondomicji”: Operacja została odrzucona, ponieważ system nie jest w stanie wymaganym do wykonania operacji. - „Przerwane”: Operacja została przerwana, zwykle z powodu problemu współbieżności, takiego jak przerywanie transakcji itp.- „Out-off-Offange”: podjęto próbę operatora po prawidłowym zakresie. - „Unimplemented”: Operacja nie jest zaimplementowana lub nie obsługiwana/włączona. - „Wewnętrzne”: błędy wewnętrzne. Oznacza, że ​​niektóre niezmienniki oczekiwane przez system podstawowy zostały zepsute. Jeśli zobaczysz jeden z tych błędów, coś jest bardzo zepsute. - „Niedostępne”: Usługa jest obecnie niedostępna. Jest to najprawdopodobniej stan przejściowy i może zostać skorygowany przez ponowne wycofanie. - „Losowanie danych”: Utrata danych lub uszkodzenie danych. - „Nieautentyczne”: żądanie nie ma prawidłowych poświadczeń uwierzytelnienia dla operacji.

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

NestedUpdatefields

Dla każdego pola (np. „Bar”) znajdź wszystkie zagnieżdżone klucze (np. { „bar.baz”: t1, „bar.qux”: t2 } ). Przecinaj je razem, aby stworzyć jedną mapę zawierającą wszystkie możliwe klucze, które są oznaczone jako opcjonalne

Podpis:

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

OrderbyDirection

Kierunek klauzuli Orderby () jest określony jako „desc” lub „asc” (zejście lub wzrost).

Podpis:

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

PartialwithfieldValue

Podobne do Partial<T> , ale pozwala na pominięcie zagnieżdżonych pola, a wartości terenowe są przekazywane jako wartości właściwości.

Podpis:

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

Prymitywny

Prymitywne typy.

Podpis:

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

QueryConstraintType

Opisuje różne ograniczenia zapytań dostępne w tym SDK.

Podpis:

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

QueryFilterConstraint

QueryFilterConstraint to pomocnik, który reprezentuje QueryfieldFilterConstraint i QueryCompositeFilterConstraint .

Podpis:

export declare type QueryFilterConstraint = QueryFieldFilterConstraint | QueryCompositeFilterConstraint;

QueryNonFilterConstraint

QueryNonFilterConstraint to pomocniczka, która reprezentuje QueryConstraintions, które są używane do zawężenia lub zamówienia zestawu dokumentów, ale które nie filtrują wyraźnie w polu dokumentu. QueryNonFilterConstraint s są tworzone przez wywołując Orderby () , startat () , startufter () , EndBefore () , endat () , limit () lub limitolast (), a następnie można je przekazać na zapytanie () , aby utworzyć nową instancję zapytania, która zawiera również QueryConstraint .

Podpis:

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

UstawOpcje

Obiekt opcji, który konfiguruje zachowanie setDoc () i wzywa. Połączenia te można skonfigurować do wykonywania szczegółowych scalów zamiast zastąpić docelowe dokumenty w całości, zapewniając SetOptions z merge: true .

Podpis:

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

UNIONTOINTERSECTION

Biorąc pod uwagę związek U = T1 | T2 | ... , Zwraca przecinany typ (T1 & T2 & ...) .

Wykorzystuje dystrybucyjne typy warunkowe i wnioskowanie z typów warunkowych. Działa to, ponieważ wielu kandydatów dla tej samej zmiennej typu w pozycjach przeciwmiennych powoduje wnioskowanie typu przecięcia. https://www.typescriptlang.org/docs/handbook/advanced-types.html#type-inference-in-onditional-types https://stackaverflow.com/questions/50374908/transform-union-type-on-intersection -typ

Podpis:

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

Aktualizować dane

Zaktualizuj dane (do użytku z UpdateC () ) To składa się ze ścieżek terenowych (np. „Foo” lub „foo.baz”) zmapowanych na wartości. Pola zawierające kody odnoszące się do zagnieżdżonych pola w dokumencie. Wartości terenowe mogą być przekazywane jako wartości właściwości.

Podpis:

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

Gdzie Filterop

Warunki filtrowania w klauzuli gdzie () są określone za pomocą ciągów „& lt;”, '& lt; =', '==', '! =', '& Gt; =', '& gt;', 'array-contains' , „in”, „array-contains-a” i „not-in”.

Podpis:

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

Z FieldValue

Umożliwia przekazanie wartości terenowych jako wartości właściwości przy jednoczesnym utrzymaniu bezpieczeństwa typu.

Podpis:

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