@firebase/firestore/lite

Funktionen

Klassen

Schnittstellen

Geben Sie Aliase ein

Funktion(App, ...)

getFirestore(App)

Gibt die vorhandene Standard- Firestore- Instanz zurück, die der bereitgestellten FirebaseApp zugeordnet ist . Wenn keine Instanz vorhanden ist, wird eine neue Instanz mit Standardeinstellungen initialisiert.

Unterschrift:

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

Parameter

Kehrt zurück:

Feuerladen

Die Firestore- Instanz der bereitgestellten App.

getFirestore(app, Datenbank-ID)

Diese API wird als Vorschau für Entwickler bereitgestellt und kann sich basierend auf dem Feedback, das wir erhalten, ändern. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Gibt die vorhandene Firestore- Instanz zurück, die der bereitgestellten FirebaseApp zugeordnet ist . Wenn keine Instanz vorhanden ist, wird eine neue Instanz mit Standardeinstellungen initialisiert.

Unterschrift:

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

Parameter

Kehrt zurück:

Feuerladen

Die Firestore- Instanz der bereitgestellten App.

initializeFirestore(App, Einstellungen)

Initialisiert eine neue Instanz von Cloud Firestore mit den bereitgestellten Einstellungen. Kann nur vor allen anderen Funktionen aufgerufen werden, einschließlich getFirestore() . Wenn die benutzerdefinierten Einstellungen leer sind, entspricht diese Funktion dem Aufruf von getFirestore() .

Unterschrift:

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

Parameter

Kehrt zurück:

Feuerladen

Eine neu initialisierte Firestore Instanz.

initializeFirestore(app, Einstellungen, Datenbank-ID)

Diese API wird als Vorschau für Entwickler bereitgestellt und kann sich basierend auf dem Feedback, das wir erhalten, ändern. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Initialisiert eine neue Instanz von Cloud Firestore mit den bereitgestellten Einstellungen. Kann nur vor allen anderen Funktionen aufgerufen werden, einschließlich getFirestore() . Wenn die benutzerdefinierten Einstellungen leer sind, entspricht diese Funktion dem Aufruf von getFirestore() .

Unterschrift:

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

Parameter

Kehrt zurück:

Feuerladen

Eine neu initialisierte Firestore Instanz.

Funktion(Firestore, ...)

Sammlung (Firestore, Pfad, Pfadsegmente)

Ruft eine CollectionReference Instanz ab, die auf die Sammlung am angegebenen absoluten Pfad verweist.

Unterschrift:

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

Parameter

Kehrt zurück:

CollectionReference < Dokumentdaten , Dokumentdaten >

Die CollectionReference Instanz.

Ausnahmen

Wenn der endgültige Pfad eine gerade Anzahl von Segmenten hat und nicht auf eine Sammlung verweist.

CollectionGroup(Firestore, CollectionId)

Erstellt eine neue Query und gibt sie zurück, die alle Dokumente in der Datenbank enthält, die in einer Sammlung oder Untersammlung mit der angegebenen collectionId enthalten sind .

Unterschrift:

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

Parameter

Kehrt zurück:

Abfrage < DocumentData , DocumentData >

Die erstellte Query .

ConnectFirestoreemulator (Firestore, Host, Port, Optionen)

Ändern Sie diese Instanz, um mit dem Cloud Firestore -Emulator zu kommunizieren.

Unterschrift:

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

Parameter

Kehrt zurück:

Leere

DOC (Firestore, Pfad, PathSegmente)

Erhält eine DocumentReference , die sich auf das Dokument auf dem angegebenen Absolute -Pfad bezieht.

Unterschrift:

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

Parameter

Kehrt zurück:

Dokumentverweis < DocumentData , DocumentData >

Die DocumentReference .

Ausnahmen

Wenn der letzte Pfad eine ungerade Anzahl von Segmenten hat und nicht auf ein Dokument verweist.

Runtransaction (Firestore, UpdateFunction, Optionen)

Führt die angegebene updateFunction aus und versucht dann, die in der Transaktion angewendeten Änderungen zu begehen. Wenn sich ein Dokument, das in der updateFunction gelesen wurde . Wenn es nach 5 Versuchen nicht begeht, schlägt die Transaktion fehl.

Die maximale Anzahl der in einer einzelnen Transaktion zulässigen Schreibvorgänge beträgt 500.

Unterschrift:

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

Parameter

Kehrt zurück:

Versprechen <t>

Wenn die Transaktion erfolgreich abgeschlossen wurde oder explizit abgebrochen wurde (die updateFunction hat ein gescheitertes Versprechen zurückgegeben), wurde das von der updateFunction zurückgegebene Versprechen zurückgegeben wird hierher zurückgegeben. Andernfalls wird ein abgelehnter Versprechen mit dem entsprechenden Fehlerfehler zurückgegeben, wenn die Transaktion fehlgeschlagen ist.

enden (firestore)

Beendet die bereitgestellte Firestore -Instanz.

Nach dem Aufrufen terminate() können nur die Funktionen clearIndexedDbPersistence() verwendet werden. Jede andere Funktion wirft einen FirestoreError . Die Kündigung storniert keine anhängigen Schreibvorgänge, und Versprechen, die auf eine Antwort vom Server warten, werden nicht behoben.

Um nach der Kündigung neu zu starten, erstellen Sie eine neue Instanz von Firestore mit GetFirestore () .

Unterschrift:

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

Parameter

Kehrt zurück:

Versprechen <void>

Ein Promise , das bei der erfolgreichen Beendigung der Instanz entschlossen ist.

WriteBatch (Firestore)

Erstellt eine Schreibstapel, die zum Ausführen mehrerer Schreibvorgänge als einzelne Atomoperation verwendet wird. Die maximale Anzahl von Schreibvorgängen, die in einem einzigen WriteBatch zulässig sind, beträgt 500.

Das Ergebnis dieser Schreibvorgänge wird nur in Dokumentlesungen widerspiegelt, die nach dem zurückgegebenen Versprechen auftreten. Wenn der Client offline ist, schlägt das Schreiben fehl. Wenn Sie lokale Modifikationen oder Puffer schreiben möchten, bis der Kunde online ist, verwenden Sie das vollständige Firestore SDK.

Unterschrift:

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

Parameter

Kehrt zurück:

WriteBatch

Ein WriteBatch , mit dem mehrere Schreibvorgänge atomisch ausgeführt werden können.

Funktion()

zählen()

Erstellen Sie ein AggregateField -Objekt, mit dem die Anzahl der Dokumente im Ergebnissatz einer Abfrage berechnet werden kann.

Unterschrift:

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

Kehrt zurück:

Aggregatefield <nummer>

Deletefield ()

Gibt einen Sentinel für die Verwendung mit updateCoc () oder setDoc () mit {merge: true} zurück, um ein Feld für das Löschen zu markieren.

Unterschrift:

export declare function deleteField(): FieldValue;

Kehrt zurück:

Feldwert

Dokument Identifikation()

Gibt einen speziellen Sentinel FieldPath zurück, um auf die ID eines Dokuments zu verweisen. Es kann in Abfragen verwendet werden, um nach der Dokument -ID zu sortieren oder zu filtern.

Unterschrift:

export declare function documentId(): FieldPath;

Kehrt zurück:

Feldweg

GetFirestore ()

Gibt die vorhandene Standard -Firestore -Instanz zurück, die mit dem Standard -FirebaseApp verbunden ist . Wenn keine Instanz besteht, initialisiert eine neue Instanz mit Standardeinstellungen.

Unterschrift:

export declare function getFirestore(): Firestore;

Kehrt zurück:

Firestore

Die Firestore -Instanz der bereitgestellten App.

serverTimestamp()

Gibt einen Sentinel zurück, der mit SetDOC () oder updateCoc () verwendet wird, um einen servergebundenen Zeitstempel in die schriftlichen Daten einzubeziehen.

Unterschrift:

export declare function serverTimestamp(): FieldValue;

Kehrt zurück:

Feldwert

Funktion (DataBaseId, ...)

GetFirestore (DataBaseId)

Diese API wird als Vorschau für Entwickler bereitgestellt und kann sich basierend auf dem von uns erhaltenen Feedback ändern. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Gibt die vorhandene Firestore -Instanz zurück, die mit dem Standard -FirebaseApp verbunden ist . Wenn keine Instanz besteht, initialisiert eine neue Instanz mit Standardeinstellungen.

Unterschrift:

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

Parameter

Kehrt zurück:

Firestore

Die Firestore -Instanz der bereitgestellten App.

Funktion (Elemente, ...)

ArrayRemove (Elemente)

Gibt einen speziellen Wert zurück, der mit setDoc () verwendet werden kann oder der dem Server die angegebene Elemente aus jedem Array -Wert entfernen kann, der bereits auf dem Server vorhanden ist. Alle Fälle jedes angegebenen Elements werden aus dem Array entfernt. Wenn das zu modifizierte Feld nicht bereits ein Array ist, wird es mit einem leeren Array überschrieben.

Unterschrift:

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

Parameter

Kehrt zurück:

Feldwert

Der FieldValue -Sentinel zur Verwendung in einem Aufruf an setDoc() oder updateDoc()

Arrayunion (Elemente)

Gibt einen speziellen Wert zurück, der mit setDoc () oder updatedoc () verwendet werden kann, der dem Server mitteilt, die angegebenen Elemente mit jedem Array -Wert zu vereinen, der bereits auf dem Server vorhanden ist. Jedes angegebenes Element, das im Array noch nicht vorhanden ist, wird am Ende hinzugefügt. Wenn das zu modifizierte Feld nicht bereits ein Array ist, wird es mit einem Array mit genau den angegebenen Elementen überschrieben.

Unterschrift:

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

Parameter

Kehrt zurück:

Feldwert

Der FieldValue -Sentinel zur Verwendung in einem Aufruf an setDoc() oder updateDoc() .

Funktion (Feld, ...)

Durchschnitt (Feld)

Erstellen Sie ein AggregateField -Objekt, mit dem der Durchschnitt eines bestimmten Feldes über einen Bereich von Dokumenten im Ergebnissatz einer Abfrage berechnet werden kann.

Unterschrift:

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

Parameter

Kehrt zurück:

Aggregatefield <Nummer | null>

Summe (Feld)

Erstellen Sie ein AggregateField -Objekt, mit dem die Summe eines bestimmten Feldes über einen Bereich von Dokumenten im Ergebnissatz einer Abfrage berechnet werden kann.

Unterschrift:

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

Parameter

Kehrt zurück:

Aggregatefield <nummer>

Funktion (FieldPath, ...)

OrderBy (FieldPath, DirectionStr)

Erstellt eine QueryOrderByConstraint , die das Abfrageergebnis nach dem angegebenen Feld sortiert, optional in absteigender Reihenfolge anstatt aufzusteigen.

Unterschrift:

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

Parameter

Kehrt zurück:

QueryOrderByConstraint

Die erstellten QueryOrderByConstraint .

Wo (FieldPath, Opstr, Wert)

Erstellt eine QueryfieldFilterConstraint , die durchdauert, dass Dokumente das angegebene Feld enthalten müssen, und dass der Wert die bereitgestellte Beziehungsbeschränkung erfüllen sollte.

Unterschrift:

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

Parameter

Kehrt zurück:

QueryfieldFilterconstraint

Das erstellte QueryfieldFilterconstraint .

Funktion (Feldwerte, ...)

Endat (Feldwerte)

Erstellt eine QueryendatConstraint , die das Ergebnis setzt, um an den bereitgestellten Feldern in Bezug auf die Reihenfolge der Abfrage zu enden. Die Reihenfolge der Feldwerte muss mit der Reihenfolge der Reihenfolge übereinstimmen.

Unterschrift:

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

Parameter

Kehrt zurück:

Queryendatconstraint

Ein Queryendatconstraint, um an query()

Endbee (Feldwerte)

Erstellt eine QueryendatConstraint , die das Ergebnis auf endet, bevor die bereitgestellten Felder in Bezug auf die Reihenfolge der Abfrage beendet sind. Die Reihenfolge der Feldwerte muss mit der Reihenfolge der Reihenfolge übereinstimmen.

Unterschrift:

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

Parameter

Kehrt zurück:

Queryendatconstraint

Ein Queryendatconstraint, um an query()

Start nach (Feldwerte)

Erstellt eine Abfragebedarf , die das Ergebnis setzt, um nach den bereitgestellten Feldern in Bezug auf die Reihenfolge der Abfrage zu beginnen. Die Reihenfolge der Feldwerte muss mit der Reihenfolge der Reihenfolge übereinstimmen.

Unterschrift:

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

Parameter

Kehrt zurück:

Abfragebedarf

Ein Querystartatkonstruktion, um an query()

Startat (Feldwerte)

Erstellt eine Abfragebedarte , die das Ergebnis setzt, um in den bereitgestellten Feldern in Bezug auf die Reihenfolge der Abfrage zu beginnen. Die Reihenfolge der Feldwerte muss mit der Reihenfolge der Reihenfolge übereinstimmen.

Unterschrift:

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

Parameter

Kehrt zurück:

Abfragebedarf

Ein Querystartatkonstruktion, um an query() .

Funktion (links, ...)

AggregateFieldEqual (links, rechts)

Vergleicht zwei 'AggregateField `Instanzen für Gleichheit.

Unterschrift:

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

Parameter

Kehrt zurück:

boolean

Aggregatequerysnapshotequal (links, rechts)

Vergleicht zwei AggregateQuerySnapshot -Instanzen für Gleichheit.

Zwei AggregateQuerySnapshot -Instanzen werden als "gleich" als "gleich" angesehen, wenn sie zugrunde liegenden Abfragen haben, die gleich vergleichen, und gleiche Daten.

Unterschrift:

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

Parameter

Kehrt zurück:

boolean

true , wenn die Objekte "gleich" sind, wie oben definiert oder sonst false .

QueryEqual (links, rechts)

Gibt true zurück, wenn die angegebenen Abfragen auf dieselbe Sammlung deuten und dieselben Einschränkungen anwenden.

Unterschrift:

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

Parameter

Kehrt zurück:

boolean

Richtig, wenn die Referenzen auf denselben Ort in derselben Firestore -Datenbank deuten.

reparal (links, rechts)

Gibt true zurück, wenn die angegebenen Referenzen gleich sind.

Unterschrift:

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

Parameter

Kehrt zurück:

boolean

Richtig, wenn die Referenzen auf denselben Ort in derselben Firestore -Datenbank deuten.

Snapshotequal (links, rechts)

Gibt true zurück, wenn die bereitgestellten Schnappschüsse gleich sind.

Unterschrift:

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

Parameter

Kehrt zurück:

boolean

wahr, wenn die Schnappschüsse gleich sind.

Funktion(Limit, ...)

Grenze (Grenze)

Erstellt eine Quylimitconstraint , die nur die ersten übereinstimmenden Dokumente zurückgibt.

Unterschrift:

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

Parameter

Kehrt zurück:

Quylimitconstraint

Die erstellten Quylimitconstraint .

limitToLast(limit)

Erstellt eine Quylimitconstraint , die nur die letzten übereinstimmenden Dokumente zurückgibt.

Sie müssen mindestens eine orderBy für limitToLast -Abfragen angeben, andernfalls wird eine Ausnahme während der Ausführung ausgelöst.

Unterschrift:

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

Parameter

Kehrt zurück:

Quylimitconstraint

Die erstellten Quylimitconstraint .

Funktion (loglevel, ...)

setLogLivel (loglevel)

Legt die Ausführlichkeit von Cloud -Firestore -Protokollen (Debugg, Irrtum oder Stille) fest.

Unterschrift:

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

Parameter

Kehrt zurück:

Leere

Funktion (n, ...)

Inkrement (n)

Gibt einen speziellen Wert zurück, der mit setDoc () oder updatedoc () verwendet werden kann, der dem Server den aktuellen Wert des Feldes durch den angegebenen Wert erhöht.

Wenn entweder der Operand oder der aktuelle Feldwert eine schwimmende Punktgenauigkeit verwendet, folgt die gesamte Arithmetik IEEE 754 Semantik. Wenn beide Werte Ganzzahlen sind, werden Werte außerhalb des sicheren Zahlenbereichs von JavaScript ( Number.MIN_SAFE_INTEGER to Number.MAX_SAFE_INTEGER ) unterliegen auch einem Präzisionsverlust. Darüber hinaus werden alle ganzzahligen Operationen zwischen -2^63 und 2^63-1 bedeckt.

Wenn der aktuelle Feldwert nicht von number ist , oder wenn das Feld noch nicht existiert, setzt die Transformation das Feld auf den angegebenen Wert.

Unterschrift:

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

Parameter

Kehrt zurück:

Feldwert

Der FieldValue -Sentinel zur Verwendung in einem Aufruf an setDoc() oder updateDoc()

Funktion(Abfrage, ...)

getaggregate (Abfrage, AggregateSpec)

Berechnet die angegebenen Aggregationen über die Dokumente im Ergebnissatz der angegebenen Abfrage, ohne die Dokumente tatsächlich herunterzuladen.

Die Verwendung dieser Funktion zur Durchführung von Aggregationen ist effizient, da nur die endgültigen Aggregationswerte und nicht die Daten der Dokumente heruntergeladen werden. Diese Funktion kann die Aggregationen der Dokumente in Fällen ausführen, in denen das Ergebnis festgelegt ist, dass das Ergebnis vollständig heruntergeladen werden kann (Tausende von Dokumenten).

Unterschrift:

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

Parameter

Kehrt zurück:

Versprechen Sie < Aggregatequerysnapshot <Aggregatespectype, AppModeltype, DBModeltype >>

Beispiel

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

Berechnet die Anzahl der Dokumente im Ergebnissatz der angegebenen Abfrage, ohne die Dokumente tatsächlich herunterzuladen.

Die Verwendung dieser Funktion zum Zählen der Dokumente ist effizient, da nur die endgültige Anzahl und nicht die Daten der Dokumente heruntergeladen werden. Diese Funktion kann die Dokumente in Fällen zählen, in denen das Ergebnissatz unerschwinglich groß ist, um vollständig herunterzuladen (Tausende von Dokumenten).

Unterschrift:

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

Parameter

Kehrt zurück:

Versprechen Sie < Aggregatequerysnapshot <{Graf: AggregateField <nummer>; }, Appmodeltype, dbmodeltype >>

Ein Versprechen, das mit der Anzahl gelöst wird; Die Anzahl kann von snapshot.data().count , wo snapshot der AggregateQuerySnapshot ist, auf den das zurückgegebene Versprechen auflöst.

getdocs (Abfrage)

Führt die Abfrage aus und gibt die Ergebnisse als Querysnapshot zurück .

Alle Abfragen werden direkt vom Server ausgeführt, auch wenn die Abfrage zuvor ausgeführt wurde. Jüngste Änderungen spiegeln sich nur in den abgerufenen Ergebnissen wider, wenn sie bereits vom Backend angewendet wurden. Wenn der Client offline ist, schlägt der Betrieb fehl. Verwenden Sie das vollständige Firestore SDK, um zuvor zwischengespeicherte Ergebnisse und lokale Modifikationen zu sehen.

Unterschrift:

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

Parameter

Kehrt zurück:

Versprechen < querysnapshot <AppModeltype, dbmodeltype >>

Ein Versprechen, das mit den Ergebnissen der Abfrage gelöst wird.

Abfrage (Abfrage, CompositeFilter, QueryConstraints)

Erstellt eine neue unveränderliche Instanz von Query , die um zusätzliche Abfrageeinschränkungen erweitert wird.

Unterschrift:

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

Parameter

Kehrt zurück:

Abfrage <AppModeltype, dbmodeltype>

Ausnahmen

Wenn eines der bereitgestellten Abfragenbeschränkungen nicht mit den vorhandenen oder neuen Einschränkungen kombiniert werden kann.

query(query, queryConstraints)

Erstellt eine neue unveränderliche Instanz von Query , die um zusätzliche Abfrageeinschränkungen erweitert wird.

Unterschrift:

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

Parameter

Kehrt zurück:

Abfrage <AppModeltype, dbmodeltype>

Ausnahmen

Wenn eines der bereitgestellten Abfragenbeschränkungen nicht mit den vorhandenen oder neuen Einschränkungen kombiniert werden kann.

Funktion (QueryConstraints, ...)

und (QueryConstraints)

Erstellt eine neue QueryCompositeFilterConstraint , die eine Konjunktion der angegebenen Filterbeschränkungen ist. Ein Konjunktionsfilter enthält ein Dokument, wenn er alle angegebenen Filter erfüllt.

Unterschrift:

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

Parameter

Kehrt zurück:

QueryCompositeFilterConstraint

Die neu erstellten QueryCompositeFilterConstraint .

oder (QueryConstraints)

Erstellt eine neue QueryCompositeFilterConstraint , die eine Disjunktion der angegebenen Filterbeschränkungen darstellt. Ein Disjunktionfilter enthält ein Dokument, wenn er einen der angegebenen Filter erfüllt.

Unterschrift:

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

Parameter

Kehrt zurück:

QueryCompositeFilterConstraint

Die neu erstellten QueryCompositeFilterConstraint .

Funktion (Referenz, ...)

Adddoc (Referenz, Daten)

Fügen Sie mit den angegebenen Daten ein neues Dokument in die angegebene CollectionReference hinzu, wodurch automatisch eine Dokument -ID zugewiesen wird.

Das Ergebnis dieses Schreibens wird nur in Dokumentlesungen widerspiegelt, die nach dem zurückgegebenen Versprechen auftreten. Wenn der Client offline ist, schlägt das Schreiben fehl. Wenn Sie lokale Modifikationen oder Puffer schreiben möchten, bis der Kunde online ist, verwenden Sie das vollständige Firestore SDK.

Unterschrift:

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

Parameter

Kehrt zurück:

Versprechen < documentreference <AppModeltype, dbmodeltype >>

Ein Promise , das mit einem DocumentReference auf das neu erstellte Dokument aufgelöst wurde, nachdem es in das Backend geschrieben wurde.

Ausnahmen

Fehler - Wenn die angegebene Eingabe kein gültiges Firestore -Dokument ist.

Sammlung (Referenz, Pfad, PathSegmente)

Erhält eine CollectionReference , die sich auf eine Unterkollektion der reference auf dem angegebenen relativen Pfad bezieht.

Unterschrift:

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

Parameter

Kehrt zurück:

Sammelreferenz < DocumentData , DocumentData >

Die CollectionReference .

Ausnahmen

Wenn der endgültige Pfad eine gleichmäßige Anzahl von Segmenten hat und nicht auf eine Sammlung verweist.

Sammlung (Referenz, Pfad, PathSegmente)

Erhält eine CollectionReference , die sich auf eine Unterkollektion der reference auf dem angegebenen relativen Pfad bezieht.

Unterschrift:

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

Parameter

Kehrt zurück:

Sammelreferenz < DocumentData , DocumentData >

Die CollectionReference .

Ausnahmen

Wenn der endgültige Pfad eine gleichmäßige Anzahl von Segmenten hat und nicht auf eine Sammlung verweist.

Deletedoc (Referenz)

Löscht das Dokument, auf das die angegebene DocumentReference genannt wird .

Die Löschung wird nur in Dokumentlesungen widerspiegelt, die nach dem zurückgegebenen Versprechen auftreten. Wenn der Client offline ist, schlägt das Löschen fehl. Wenn Sie lokale Modifikationen oder Puffer schreiben möchten, bis der Kunde online ist, verwenden Sie das vollständige Firestore SDK.

Unterschrift:

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

Parameter

Kehrt zurück:

Versprechen <void>

Ein Promise , das gelöst wurde, sobald das Dokument erfolgreich aus dem Backend gelöscht wurde.

DOC (Referenz, Pfad, PathSegmente)

Erhält eine DocumentReference , die sich auf ein Dokument innerhalb der reference auf dem angegebenen relativen Pfad bezieht. Wenn kein DocumentReference angegeben ist .

Unterschrift:

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

Parameter

Kehrt zurück:

Dokumentverweis <AppModeltype, dbmodeltype>

Die DocumentReference .

Ausnahmen

Wenn der letzte Pfad eine ungerade Anzahl von Segmenten hat und nicht auf ein Dokument verweist.

DOC (Referenz, Pfad, PathSegmente)

Erhält eine DocumentReference , die sich auf ein Dokument innerhalb der reference auf dem angegebenen relativen Pfad bezieht.

Unterschrift:

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

Parameter

Kehrt zurück:

Dokumentverweis < DocumentData , DocumentData >

Die DocumentReference .

Ausnahmen

Wenn der letzte Pfad eine ungerade Anzahl von Segmenten hat und nicht auf ein Dokument verweist.

getdoc (Referenz)

Liest das Dokument, auf das die angegebene Dokumentreferenz genannt wird.

Alle Dokumente werden direkt aus dem Server abgerufen, auch wenn das Dokument zuvor gelesen oder geändert wurde. Jüngste Änderungen spiegeln sich nur in den abgerufenen DocumentSnapshot mit, wenn sie bereits vom Backend angewendet wurden. Wenn der Client offline ist, schlägt die Lektüre fehl. Wenn Sie Caching verwenden oder lokale Änderungen ansehen möchten, verwenden Sie bitte den vollständigen Firestore SDK.

Unterschrift:

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

Parameter

Kehrt zurück:

Versprechen < documentsnapshot <AppModeltype, dbmodeltype >>

Ein Versprechen, das mit einem DocumentSnapshot mit dem aktuellen Dokumentinhalt gelöst wurde.

setDoc (Referenz, Daten)

Schreibvorgänge in das von der angegebene DocumentReference genannte Dokument . Wenn das Dokument noch nicht vorhanden ist, wird es erstellt.

Das Ergebnis dieses Schreibens wird nur in Dokumentlesungen widerspiegelt, die nach dem zurückgegebenen Versprechen auftreten. Wenn der Client offline ist, schlägt das Schreiben fehl. Wenn Sie lokale Modifikationen oder Puffer schreiben möchten, bis der Kunde online ist, verwenden Sie das vollständige Firestore SDK.

Unterschrift:

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

Parameter

Kehrt zurück:

Versprechen <void>

Ein Promise , das gelöst wurde, sobald die Daten erfolgreich in das Backend geschrieben wurden.

Ausnahmen

Fehler - Wenn die angegebene Eingabe kein gültiges Firestore -Dokument ist.

SetDOC (Referenz, Daten, Optionen)

Schreibvorgänge in das von der angegebene DocumentReference genannte Dokument . Wenn das Dokument noch nicht vorhanden ist, wird es erstellt. Wenn Sie merge oder mergeFields bereitstellen Die bereitgestellten Daten können in ein vorhandenes Dokument zusammengefasst werden.

Das Ergebnis dieses Schreibens wird nur in Dokumentlesungen widerspiegelt, die nach dem zurückgegebenen Versprechen auftreten. Wenn der Client offline ist, schlägt das Schreiben fehl. Wenn Sie lokale Modifikationen oder Puffer schreiben möchten, bis der Kunde online ist, verwenden Sie das vollständige Firestore SDK.

Unterschrift:

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

Parameter

Kehrt zurück:

Versprechen <void>

Ein Promise , das gelöst wurde, sobald die Daten erfolgreich in das Backend geschrieben wurden.

Ausnahmen

Fehler - Wenn die angegebene Eingabe kein gültiges Firestore -Dokument ist.

updatedoc (Referenz, Daten)

Aktualisiert Felder im Dokument, auf das die angegebenen DocumentReference genannt werden . Das Update schlägt fehl, wenn sie auf ein Dokument angewendet wird, das nicht vorhanden ist.

Das Ergebnis dieses Updates wird nur in Dokumentlesungen widerspiegelt, die nach dem zurückgegebenen Versprechen auftreten. Wenn der Client offline ist, schlägt das Update fehl. Wenn Sie lokale Modifikationen oder Puffer schreiben möchten, bis der Kunde online ist, verwenden Sie das vollständige Firestore SDK.

Unterschrift:

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

Parameter

Kehrt zurück:

Versprechen <void>

Ein Promise , das gelöst wurde, sobald die Daten erfolgreich in das Backend geschrieben wurden.

Ausnahmen

Fehler - Wenn die bereitgestellte Eingabe keine gültigen Firestore -Daten ist.

Aktualisiert (Referenz, Feld, Wert, MehrfieldsandValues))

Aktualisierungsfelder im Dokument, auf das die angegebene DocumentReference bezeichnet wird. Das Update wird fehlschlagen, wenn sie auf ein Dokument angewendet werden, das nicht vorhanden ist.

Verschachtelte Felder können aktualisiert werden, indem dot-getrennte Feldpfadzeichenfolgen oder die Bereitstellung FieldPath Objekten bereitgestellt werden.

Das Ergebnis dieses Updates wird nur in Dokumentlesungen widerspiegelt, die nach dem zurückgegebenen Versprechen auftreten. Wenn der Client offline ist, schlägt das Update fehl. Wenn Sie lokale Modifikationen oder Puffer schreiben möchten, bis der Kunde online ist, verwenden Sie das vollständige Firestore SDK.

Unterschrift:

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

Parameter

Kehrt zurück:

Versprechen <void>

Ein Promise , das gelöst wurde, sobald die Daten erfolgreich in das Backend geschrieben wurden.

Ausnahmen

Fehler - Wenn die bereitgestellte Eingabe keine gültigen Firestore -Daten ist.

Funktion (Snapshot, ...)

Endat (Snapshot)

Erstellt eine Queryendatconstraint , die das Ergebnis setzt, um am angegebenen Dokument zu enden (inklusive). Die Endposition ist relativ zur Reihenfolge der Abfrage. Das Dokument muss alle in der Reihenfolge der Abfrage bereitgestellten Felder enthalten.

Unterschrift:

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

Parameter

Kehrt zurück:

Queryendatconstraint

Ein Queryendatconstraint, um an query()

Endbee (Snapshot)

Erstellt eine QueryendatConstraint , die das Ergebnissatz auf enden vor dem angegebenen Dokument (exklusiv) ändert. Die Endposition ist relativ zur Reihenfolge der Abfrage. Das Dokument muss alle in der Reihenfolge der Abfrage bereitgestellten Felder enthalten.

Unterschrift:

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

Parameter

Kehrt zurück:

Queryendatconstraint

Ein Queryendatconstraint, um an query()

Start nach (Snapshot)

Erstellt eine Abfragebedarte , die das Ergebnis -Set so ändert, dass sie nach dem angegebenen Dokument (exklusiv) beginnen. Die Ausgangsposition ist relativ zur Reihenfolge der Abfrage. Das Dokument muss alle in der Reihenfolge der Abfrage bereitgestellten Felder enthalten.

Unterschrift:

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

Parameter

Kehrt zurück:

Abfragebedarf

Ein Querystartatkonstruktion, um an query()

Startat (Snapshot)

Erstellt eine Abfragebedakte , die das Ergebnis eingestellt wird, um im angegebenen Dokument (inklusive) zu beginnen. Die Ausgangsposition ist relativ zur Reihenfolge der Abfrage. Das Dokument muss alle in der orderBy dieser Abfrage bereitgestellten Felder enthalten.

Unterschrift:

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

Parameter

Kehrt zurück:

Abfragebedarf

Ein Querystartatkonstruktion, um an query() .

Addprefixtokeys

Gibt eine neue Karte zurück, auf der jeder Schlüssel mit dem an einen Punkt angehängten äußeren Schlüssel vorangestellt ist.

Unterschrift:

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

Die Vereinigung aller AggregateField -Typen, die von Firestore unterstützt werden.

Unterschrift:

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

Aggregatespecdata

Ein Typ, dessen Schlüssel aus einem AggregateSpec entnommen wird und deren Werte das Ergebnis der Aggregation sind, die vom entsprechenden AggregateField aus der AggregateSpec durchgeführt wird .

Unterschrift:

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

Aggregatetyp

Gewerkschaftstyp, der den zu ausgeführten Gesamttyp darstellt.

Unterschrift:

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

Childupdatefields

Helfer zur Berechnung der verschachtelten Felder für einen bestimmten Typ T1. Dies ist erforderlich, um Gewerkschaftstypen wie undefined | {...} zu verteilen undefined | {...} (passiert für optionale Requisiten) oder {a: A} | {b: B} .

In diesem Anwendungsfall wird V verwendet, um die Gewerkschaftstypen von T[K] Record Da T[K] als Ausdruck bewertet und nicht verteilt wird.

Siehe https://www.typescriptlang.org/docs/handbook/advanced-types.html#distributive-Conditional-types

Unterschrift:

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

FirestoreErrorCode

Die Reihe von Firestore -Statuscodes. Die Codes sind gleich an den von GRPC hier ausgesetzt

Mögliche Werte: - 'Storniert': Die Operation wurde storniert (normalerweise vom Anrufer). - 'Unbekannt': Unbekannter Fehler oder Fehler aus einer anderen Fehlerdomäne. - 'ungültiges Argument': Client hat ein ungültiges Argument angegeben. Beachten Sie, dass dies von "fehlgeschlagener Präkondition" unterscheidet. 'Invalid-Argument' gibt Argumente an, die unabhängig vom Zustand des Systems problematisch sind (z. B. ein ungültiger Feldname). - 'Deadline-Expreate': Frist, die vor Abschluss des Betriebs abgelaufen ist. Für Operationen, die den Status des Systems ändern, kann dieser Fehler auch dann zurückgegeben werden, wenn der Betrieb erfolgreich abgeschlossen ist. Zum Beispiel hätte eine erfolgreiche Antwort eines Servers lange genug verzögert werden können, damit die Frist abgelaufen ist. - 'nicht fundiert': Einige angeforderte Dokument wurden nicht gefunden. - 'Bothone-Exists': Ein Dokument, das wir bereits erstellen versuchten, gibt es bereits. . . - 'fehlgeschlagene Vorkondition': Der Betrieb wurde abgelehnt, da sich das System nicht in einem Zustand befindet, der für die Ausführung des Betriebs erforderlich ist. - 'abgebrochen': Die Operation wurde abgebrochen, typischerweise aufgrund eines Problems mit Parallelität wie Transaktionsabbruch usw.- 'Out-of-of-A-of-Range': Die Operation wurde versucht, die gültige Reichweite zu überschreiten. - 'Unimplemented': Der Betrieb wird nicht implementiert oder nicht unterstützt/aktiviert. - 'Internal': interne Fehler. Bedeutet, dass einige Invarianten, die nach dem zugrunde liegenden System erwartet werden, gebrochen wurde. Wenn Sie einen dieser Fehler sehen, ist etwas sehr kaputt. - 'nicht verfügbar': Der Dienst ist derzeit nicht verfügbar. Dies ist höchstwahrscheinlich eine vorübergehende Bedingung und kann durch Wiederieren mit einem Backoff korrigiert werden. - 'Data-Loss': Nicht wiedervertragbarer Datenverlust oder Korruption. - 'nicht authentifiziert': Die Anfrage hat keine gültigen Authentifizierungsanmeldeinformationen für den Vorgang.

Unterschrift:

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

Finden Sie für jedes Feld (zB 'Bar') alle verschachtelten Schlüssel (z. B. { 'bar.baz': t1, 'bar.qux': t2 } ). Schneiden Sie sie zusammen, um eine einzelne Karte mit allen möglichen Schlüssel zu erstellen, die alle als optional gekennzeichnet sind

Unterschrift:

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

OrderByDirection

Die Richtung einer OrderBy () -Klausel wird als "Desc" oder "ASC" (absteigend oder aufsteigend) angegeben.

Unterschrift:

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

PartiellWithfieldValue

Ähnlich wie bei Partial<T> , aber ermöglicht, dass verschachtelte Felder weggelassen werden und Feldvalues ​​als Eigenschaftswerte übergeben werden.

Unterschrift:

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

Primitive

Primitive Typen.

Unterschrift:

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

QueryConstraintType

Beschreibt die verschiedenen Abfrageeinschränkungen, die in diesem SDK verfügbar sind.

Unterschrift:

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

QueryFilterconstraint

QueryFilterConstraint ist ein Helfer -Unionstyp, der QueryfieldFilterConstraint und QueryCompositeFilterConstraint darstellt .

Unterschrift:

export declare type QueryFilterConstraint = QueryFieldFilterConstraint | QueryCompositeFilterConstraint;

QuerynonFilterconstraint

QueryNonFilterConstraint ist ein Helfer -Gewerkschaftstyp, der Abfragen darstellt, die zur Begrenzung oder Bestellung der Dokumente verwendet werden, die jedoch nicht explizit in einem Dokumentfeld filtern. QueryNonFilterConstraint s werden durch Aufrufen von OrderBy () erstellt , anfangen bei() , startAfter() , endBefore() , Endat () , limit () oder limittolast () und kann dann an query () übergeben werden, um eine neue Abfrageinstanz zu erstellen, die auch die QueryConstraint enthält .

Unterschrift:

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

Setoptionen

Ein Optionsobjekt, das das Verhalten von setDoc () konfiguriert und Anrufe. Diese Anrufe können so konfiguriert werden, dass sie granulare Zusammenschlüsse durchführen, anstatt die Zieldokumente in ihrer Gesamtheit zu überschreiben, indem SetOptions mit merge: true bereitgestellt werden .

Unterschrift:

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

UnionTointersection

Bei einem Gewerkschaftstyp U = T1 | T2 | ... Gibt einen überarbeiteten Typ zurück (T1 & T2 & ...) .

Verwendet verteilte bedingte Typen und Inferenz von bedingten Typen. Dies funktioniert, da mehrere Kandidaten für die gleiche Typvariable in kontravarianten Positionen dazu führen, dass ein Schnitttyp abgeleitet wird. https://www.typescriptlang.org/docs/handbook/advanced-types.html#type-inference-in-conditional-types https://stackoverflow.com/questions/50374908/transform-union-type-t-intinction -Typ

Unterschrift:

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

Daten aktualisieren

Daten aktualisieren (zur Verwendung mit updateCoc () ) Das besteht aus Feldpfaden (z. B. 'foo' oder 'foo.baz'), die den Werten zugeordnet sind. Felder, die Punkte enthalten, verweisen auf verschachtelte Felder im Dokument. Feldwerte können als Eigenschaftswerte übergeben werden.

Unterschrift:

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

Wo filterop

Filterbedingungen in einer WO () -Klausel werden unter Verwendung der Zeichenfolgen '& lt;', '& lt; =', '==', '! =', '& Gt; =', '& gt;', 'Array-Contains' angegeben. , 'in', 'Array-Contains-Any' und 'Not-in'.

Unterschrift:

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

WithfieldValue

Ermöglicht den Feldvalues ​​als Eigenschaftswert, gleichzeitig die Art der Art zu erhalten.

Unterschrift:

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