@firebase/firestore

Les fonctions

Des classes

Interfaces

Variables

Tapez les alias

fonction (app, ...)

getFirestore (app)

Renvoie l'instance Firestore par défaut existante qui est associée au FirebaseApp fourni . Si aucune instance n'existe, initialise une nouvelle instance avec des paramètres par défaut.

Signature:

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

Paramètres

Retour:

Firestore

L'instance Firestore par défaut de l'application fournie.

getFirestore (application, databaseid)

Cette API est fournie comme un aperçu des développeurs et peut changer en fonction des commentaires que nous recevons. N'utilisez pas cette API dans un environnement de production.

Renvoie l'instance Firestore nommée existante associée au FirebaseApp fourni . Si aucune instance n'existe, initialise une nouvelle instance avec des paramètres par défaut.

Signature:

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

Paramètres

Retour:

Firestore

L'instance nommée Firestore de l'application fournie.

InitializeFireStore (App, Paramètres, DatabaseID)

Initialise une nouvelle instance de Firestore avec les paramètres fournis. Ne peut être appelé qu'avant toute autre fonction, y compris getFirestore () . Si les paramètres personnalisés sont vides, cette fonction équivaut à appeler getFirestore () .

Signature:

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

Paramètres

Retour:

Firestore

Une instance Firestore nouvellement initialisée.

Fonction (Firestore, ...)

ClearIndexedDBPersistence (Firestore)

Efface le stockage persistant. Cela comprend les écritures en attente et les documents mis en cache.

Doit être appelé pendant que l'instance Firestore n'est pas démarrée (après la fin de l'application ou lorsque l'application est initialisée pour la première fois). Au démarrage, cette fonction doit être appelée avant d'autres fonctions (autres que initializeFirestore () ou getFirestore () )). Si l'instance de Firestore est toujours en cours d'exécution, la promesse sera rejetée avec le code d'erreur de failed-precondition .

Signature:

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

Paramètres

Retour:

Promesse <void>

Une Promise qui est résolue lorsque le stockage persistant est effacé. Sinon, la promesse est rejetée avec une erreur.

Collection (Firestore, Path, Pathsegments)

Obtient une instance CollectionReference qui fait référence à la collection sur le chemin absolu spécifié.

Signature:

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

Paramètres

Retour:

Relevé de collecte < DocumentData , DocumentData >

L'instance CollectionReference .

Des exceptions

Si le chemin final a un nombre uniforme de segments et ne pointe pas vers une collection.

CollectionGroup (Firestore, CollectionID)

Crée et renvoie une nouvelle instance Query qui comprend tous les documents de la base de données qui sont contenus dans une collection ou une sous-collection avec la collectionId donnée .

Signature:

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

Paramètres

Retour:

Requête < DocumentData , DocumentData >

La Query créée .

ConnectFireStoreMulator (Firestore, hôte, port, options)

Modifiez cette instance pour communiquer avec l'émulateur Cloud Firestore.

Signature:

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

Paramètres

Retour:

vide

Disablenetwork (Firestore)

Désactive l'utilisation du réseau pour cette instance. Il peut être réactivé via INABLENETWORK () . Bien que le réseau soit désactivé, tous les écouteurs d'instantané, getDoc() ou getDocs() rendront les résultats de Cache, et toutes les opérations d'écriture seront mis en file d'attente jusqu'à ce que le réseau soit restauré.

Signature:

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

Paramètres

Retour:

Promesse <void>

Une Promise qui est résolue une fois le réseau désactivé.

Doc (Firestore, Path, Pathsegments)

Obtient une instance DocumentReference qui fait référence au document sur le chemin absolu spécifié.

Signature:

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

Paramètres

Retour:

Référence de document < DocumentData , DocumentData >

L'instance DocumentReference .

Des exceptions

Si le chemin final a un nombre impair de segments et ne pointe pas vers un document.

Activer InternetDDBPersistence (Firestore, PersistanceSettings)

Cette fonction sera supprimée dans une future version majeure. Au lieu de cela, définissez FirestoreSettings.localCache sur une instance de PersistentLocalCache pour activer le cache indexédb. L'appel de cette fonction lorsque FirestoreSettings.localCache est déjà spécifié lancera une exception.

Tente d'activer le stockage persistant, si possible.

En cas de défaillance, enableIndexedDbPersistence() rejetera la promesse ou lancera une exception. Il y a plusieurs raisons pour lesquelles cela peut échouer, qui peut être identifié par le code sur l'erreur.

* Déchec de l'échec: l'application est déjà ouverte dans un autre onglet de navigateur. * UNIMPLIPÉRÉ: Le navigateur est incompatible avec la mise en œuvre de persistance hors ligne.

Notez que même après un échec, l'instance Firestore restera utilisable, mais la persistance hors ligne sera désactivée.

La persistance ne peut pas être utilisée dans un environnement Node.js.

Signature:

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

Paramètres

Retour:

Promesse <void>

Une Promise qui représente avec succès l'activation du stockage persistant.

ImmatEmultitAbindexedDBPersistence (Firestore)

Cette fonction sera supprimée dans une future version majeure. Au lieu de cela, définissez FirestoreSettings.localCache sur une instance de PersistentLocalCache pour activer le cache indexédb. L'appel de cette fonction lorsque FirestoreSettings.localCache est déjà spécifié lancera une exception.

Tente d'activer le stockage persistant multi-tab, si possible. S'ils sont activés sur tous les onglets, toutes les opérations partagent l'accès à la persistance locale, y compris l'exécution partagée des requêtes et les mises à jour de documents locaux compensées à la latence sur toutes les instances connectées.

En cas de défaillance, enableMultiTabIndexedDbPersistence() rejetera la promesse ou lancera une exception. Il y a plusieurs raisons pour lesquelles cela peut échouer, qui peut être identifié par le code sur l'erreur.

* Déchec de l'échec: l'application est déjà ouverte dans un autre onglet de navigateur et Multi-Tab n'est pas activé. * UNIMPLIPÉRÉ: Le navigateur est incompatible avec la mise en œuvre de persistance hors ligne.

Notez que même après un échec, l'instance Firestore restera utilisable, mais la persistance hors ligne sera désactivée.

Signature:

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

Paramètres

Retour:

Promesse <void>

Une Promise qui représente avec succès l'activation du stockage persistant.

ImageNetwork (Firestore)

Réactivité l'utilisation du réseau pour cette instance Firestore après un appel préalable à DisableNetwork () .

Signature:

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

Paramètres

Retour:

Promesse <void>

Une Promise qui est résolue une fois le réseau activé.

getPersistentCacheIndexManager (Firestore)

Renvoie le gestionnaire d'index persistantCache utilisé par l'objet Firestore donné.

L'instance PersistentCacheIndexManager , ou null si le stockage persistant local n'est pas utilisé.

Signature:

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

Paramètres

Retour:

PersistantCacheIndexManager | nul

Loadbundle (Firestore, Bundledata)

Charge un pack Firestore dans le cache local.

Signature:

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

Paramètres

Retour:

LoadBundletask

Un objet LoadBundleTask , qui informe les appelants avec les mises à jour de progression et les événements d'achèvement ou d'erreur. Il peut être utilisé comme Promise<LoadBundleTaskProgress> .

NAMBOSQUE (Firestore, nom)

Lire une requête Firestore de Cache local, identifiée par le nom donné.

Les requêtes nommées sont emballées en faisceaux du côté serveur (avec des documents résultants) et chargés en cache local à l'aide loadBundle . Une fois dans le cache local, utilisez cette méthode pour extraire une requête par nom.

Signature:

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

Paramètres

Retour:

Promesse < requête | null>

Une Promise qui est résolue avec la requête ou null .

OnsnapshotsInsync (Firestore, Observer)

Attache un auditeur pour un événement Snapshots-in-Sync. L'événement Snapshots-in-Sync indique que tous les auditeurs affectés par un changement donné ont été tirés, même si un seul changement généré par un serveur affecte plusieurs auditeurs.

Remarque: L'événement SnapshoTs-in-Sync indique uniquement que les auditeurs sont synchronisés les uns avec les autres, mais ne se rapporte pas à la synchronisation des instantanés avec le serveur. Utilisez SnapshotMetadata dans les auditeurs individuels pour déterminer si un instantané provient du cache ou du serveur.

Signature:

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

Paramètres

Retour:

Se désabonner

Une fonction de désabonnement qui peut être appelée pour annuler l'écouteur instantané.

OnsnapshotsInsync (Firestore, Onsync)

Attache un auditeur pour un événement Snapshots-in-Sync. L'événement Snapshots-in-Sync indique que tous les auditeurs affectés par un changement donné ont été tirés, même si un seul changement généré par un serveur affecte plusieurs auditeurs.

Remarque: L'événement SnapshoTs-in-Sync indique uniquement que les auditeurs sont synchronisés les uns avec les autres, mais ne se rapporte pas à la synchronisation des instantanés avec le serveur. Utilisez SnapshotMetadata dans les auditeurs individuels pour déterminer si un instantané provient du cache ou du serveur.

Signature:

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

Paramètres

Retour:

Se désabonner

Une fonction de désabonnement qui peut être appelée pour annuler l'écouteur instantané.

RunTransaction (Firestore, mise à jour, options)

Exécute la updateFunction donnée, puis tente de commettre les modifications appliquées dans la transaction. Si un document lu dans la transaction a changé, Cloud Firestore récupère la updateFunction . S'il ne s'engage pas après 5 tentatives, la transaction échoue.

Le nombre maximum d'écritures autorisées dans une seule transaction est de 500.

Signature:

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

Paramètres

Retour:

Promesse <T>

Si la transaction s'est terminée avec succès ou a été explicitement abandonnée (la updateFunction a renvoyé une promesse ratée), la promesse renvoyée par la updateFunction est retourné ici. Sinon, si la transaction a échoué, une promesse rejetée avec l'erreur de défaillance correspondante est renvoyée.

setIndexConfiguration (Firestore, configuration)

Cette API est fournie comme un aperçu des développeurs et peut changer en fonction des commentaires que nous recevons. N'utilisez pas cette API dans un environnement de production.

Au lieu de créer des index de cache manuellement, envisagez d'utiliser enablePersistentCacheIndexAutoCreation() pour permettre au SDK de décider de créer des index de cache pour les requêtes en cours d'exécution localement.

Configure l'indexation pour l'exécution de la requête locale. Toute configuration d'index précédente est remplacée. La Promise résout une fois la configuration d'index persistante.

Les entrées d'index elles-mêmes sont créées de manière asynchrone. Vous pouvez continuer à utiliser des requêtes qui nécessitent une indexation même si les indices ne sont pas encore disponibles. L'exécution de la requête commencera automatiquement à utiliser l'index une fois que les entrées d'index auront été écrites.

Les index ne sont pris en charge qu'avec une persistance indexée. Si indededDB n'est pas activé, toute configuration d'index est ignorée.

Signature:

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

Paramètres

Retour:

Promesse <void>

Une Promise qui résout une fois que tous les indices sont configurés avec succès.

Des exceptions

FirestoreError si le format JSON n'est pas valide.

setIndexConfiguration (Firestore, JSON)

Cette API est fournie comme un aperçu des développeurs et peut changer en fonction des commentaires que nous recevons. N'utilisez pas cette API dans un environnement de production.

Au lieu de créer des index de cache manuellement, envisagez d'utiliser enablePersistentCacheIndexAutoCreation() pour permettre au SDK de décider de créer des index de cache pour les requêtes en cours d'exécution localement.

Configure l'indexation pour l'exécution de la requête locale. Toute configuration d'index précédente est remplacée. La Promise résout une fois la configuration d'index persistante.

Les entrées d'index elles-mêmes sont créées de manière asynchrone. Vous pouvez continuer à utiliser des requêtes qui nécessitent une indexation même si les indices ne sont pas encore disponibles. L'exécution de la requête commencera automatiquement à utiliser l'index une fois que les entrées d'index auront été écrites.

Les index ne sont pris en charge qu'avec une persistance indexée. Invoquez Activer enableIndexedDbPersistence() ou enableMultiTabIndexedDbPersistence() avant de définir une configuration d'index. Si indededDB n'est pas activé, toute configuration d'index est ignorée.

La méthode accepte le format JSON exporté par la CLI Firebase ( firebase firestore:indexes ). Si le format JSON n'est pas valide, cette méthode lance une erreur.

Signature:

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

Paramètres

Retour:

Promesse <void>

Une Promise qui résout une fois que tous les indices sont configurés avec succès.

Des exceptions

FirestoreError si le format JSON n'est pas valide.

Terminer (Firestore)

Termine l'instance Firestore fournie.

Après avoir appelé terminate() seule la fonction clearIndexedDbPersistence() peut être utilisée. Toute autre fonction lancera une FirestoreError .

Pour redémarrer après la terminaison, créez une nouvelle instance de FirebaseFirestore avec getFirestore () .

La terminaison n'annule aucune écriture en attente, et toute promesse qui attend une réponse du serveur ne sera pas résolue. Si vous avez activé la persistance, la prochaine fois que vous démarrez cette instance, il reprendra l'envoi de ces écritures au serveur.

Signature:

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

Paramètres

Retour:

Promesse <void>

Une Promise qui est résolue lorsque l'instance a été terminée avec succès.

WaitForpendingWrites (Firestore)

Attend que toutes les écritures actuellement en attente pour l'utilisateur actif aient été reconnues par le backend.

La promesse retournée résout immédiatement s'il n'y a pas d'écrits exceptionnels. Sinon, la promesse attend toutes les écritures publiées précédemment (y compris celles écrites lors d'une session d'application précédente), mais elle n'attend pas d'écritures qui ont été ajoutées après l'appel de la fonction. Si vous souhaitez attendre des écritures supplémentaires, appelez à nouveau waitForPendingWrites() .

Toutes les promesses waitForPendingWrites() en suspens sont rejetées lors des modifications de l'utilisateur.

Signature:

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

Paramètres

Retour:

Promesse <void>

Une Promise qui résout lorsque toutes les écritures en cours en cours ont été reconnues par le backend.

WriteBatch (Firestore)

Crée un lot d'écriture, utilisé pour effectuer plusieurs écritures comme une seule opération atomique. Le nombre maximum d'écritures autorisées dans un seul WriteBatch est de 500.

Contrairement aux transactions, les lots d'écriture sont persistés hors ligne et sont donc préférables lorsque vous n'avez pas besoin de conditionner vos écritures sur les données de lecture.

Signature:

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

Paramètres

Retour:

Writebatch

Un WriteBatch qui peut être utilisé pour exécuter atomiquement plusieurs écritures.

fonction()

compter()

Créez un objet agrégateField qui peut être utilisé pour calculer le nombre de documents dans l'ensemble de résultats d'une requête.

Signature:

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

Retour:

Agrégatfield <graisser>

DeleteField ()

Renvoie une Sentinel à utiliser avec UpdatedOC () ou setDoc () avec {merge: true} pour marquer un champ pour la suppression.

Signature:

export declare function deleteField(): FieldValue;

Retour:

Surface

documentId ()

Renvoie un FieldPath Sentinel spécial pour se référer à l'ID d'un document. Il peut être utilisé dans les requêtes pour trier ou filtrer par l'ID de document.

Signature:

export declare function documentId(): FieldPath;

Retour:

Parcours de terrain

getFirestore ()

Renvoie l'instance Firestore par défaut existante qui est associée au FirebaseApp par défaut . Si aucune instance n'existe, initialise une nouvelle instance avec des paramètres par défaut.

Signature:

export declare function getFirestore(): Firestore;

Retour:

Firestore

L'instance Firestore par défaut de l'application par défaut.

MemoteEagerGarBageCollector ()

Crée une instance de MemoryEagerGarbageCollector . Il s'agit également du collecteur de déchets par défaut, sauf s'il est explicitement spécifié autrement.

Signature:

export declare function memoryEagerGarbageCollector(): MemoryEagerGarbageCollector;

Retour:

MemoryeagergarBageCollecteur

persistantMultipletAbManager ()

Crée une instance de PersistentMultipleTabManager .

Signature:

export declare function persistentMultipleTabManager(): PersistentMultipleTabManager;

Retour:

Persistant-mortipletabmanager

servertimestamp ()

Renvoie une sentinelle utilisée avec SetDoc () ou UpdatedOC () pour inclure un horodatage généré par le serveur dans les données écrites.

Signature:

export declare function serverTimestamp(): FieldValue;

Retour:

Surface

fonction (databaseid, ...)

getFirestore (databaseid)

Cette API est fournie comme un aperçu des développeurs et peut changer en fonction des commentaires que nous recevons. N'utilisez pas cette API dans un environnement de production.

Renvoie l'instance Firestore nommée existante associée au FirebaseApp par défaut . Si aucune instance n'existe, initialise une nouvelle instance avec des paramètres par défaut.

Signature:

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

Paramètres

Retour:

Firestore

L'instance nommée Firestore de l'application par défaut.

fonction (éléments, ...)

ArrayRemove (éléments)

Renvoie une valeur spéciale qui peut être utilisée avec SetDoc () ou qui indique au serveur de supprimer les éléments donnés de toute valeur de tableau qui existe déjà sur le serveur. Toutes les instances de chaque élément spécifié seront supprimées du tableau. Si le champ modifié n'est pas déjà un tableau, il sera écrasé avec un tableau vide.

Signature:

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

Paramètres

Retour:

Surface

Le champ Sentinel FieldValue à utiliser dans un appel à setDoc() ou updateDoc()

ArrayUnion (éléments)

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

Signature:

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

Paramètres

Retour:

FieldValue

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

function(field, ...)

average(field)

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

Signature:

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

Paramètres

Retour:

AggregateField <number | null>

sum(field)

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

Signature:

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

Paramètres

Retour:

AggregateField <number>

function(fieldPath, ...)

orderBy(fieldPath, directionStr)

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

Signature:

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

Paramètres

Retour:

QueryOrderByConstraint

The created QueryOrderByConstraint .

where(fieldPath, opStr, value)

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

Signature:

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

Paramètres

Retour:

QueryFieldFilterConstraint

The created QueryFieldFilterConstraint .

function(fieldValues, ...)

endAt(fieldValues)

Creates a QueryEndAtConstraint that modifies the result set to end at the provided fields relative to the order of the query. The order of the field values must match the order of the order by clauses of the query.

Signature:

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

Paramètres

Retour:

QueryEndAtConstraint

A QueryEndAtConstraint to pass to query()

endBefore(fieldValues)

Creates a QueryEndAtConstraint that modifies the result set to end before the provided fields relative to the order of the query. The order of the field values must match the order of the order by clauses of the query.

Signature:

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

Paramètres

Retour:

QueryEndAtConstraint

A QueryEndAtConstraint to pass to query()

startAfter(fieldValues)

Creates a QueryStartAtConstraint that modifies the result set to start after the provided fields relative to the order of the query. The order of the field values must match the order of the order by clauses of the query.

Signature:

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

Paramètres

Retour:

QueryStartAtConstraint

A QueryStartAtConstraint to pass to query()

startAt(fieldValues)

Creates a QueryStartAtConstraint that modifies the result set to start at the provided fields relative to the order of the query. The order of the field values must match the order of the order by clauses of the query.

Signature:

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

Paramètres

Retour:

QueryStartAtConstraint

A QueryStartAtConstraint to pass to query() .

function(indexManager, ...)

deleteAllPersistentCacheIndexes(indexManager)

Removes all persistent cache indexes.

Please note this function will also deletes indexes generated by setIndexConfiguration() , which is deprecated.

Signature:

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

Paramètres

Retour:

vide

disablePersistentCacheIndexAutoCreation(indexManager)

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

Signature:

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

Paramètres

Retour:

vide

enablePersistentCacheIndexAutoCreation(indexManager)

Enables the SDK to create persistent cache indexes automatically for local query execution when the SDK believes cache indexes can help improve performance.

Cette fonctionnalité est désactivée par défaut.

Signature:

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

Paramètres

Retour:

vide

function(left, ...)

aggregateFieldEqual(left, right)

Compares two 'AggregateField ` instances for equality.

Signature:

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

Paramètres

Retour:

booléen

aggregateQuerySnapshotEqual(left, right)

Compares two AggregateQuerySnapshot instances for equality.

Two AggregateQuerySnapshot instances are considered "equal" if they have underlying queries that compare equal, and the same data.

Signature:

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

Paramètres

Retour:

booléen

true if the objects are "equal", as defined above, or false otherwise.

queryEqual(left, right)

Returns true if the provided queries point to the same collection and apply the same constraints.

Signature:

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

Paramètres

Retour:

booléen

true if the references point to the same location in the same Firestore database.

refEqual(left, right)

Returns true if the provided references are equal.

Signature:

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

Paramètres

Retour:

booléen

true if the references point to the same location in the same Firestore database.

snapshotEqual(left, right)

Returns true if the provided snapshots are equal.

Signature:

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

Paramètres

Retour:

booléen

true if the snapshots are equal.

function(limit, ...)

limit(limit)

Creates a QueryLimitConstraint that only returns the first matching documents.

Signature:

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

Paramètres

Retour:

QueryLimitConstraint

The created QueryLimitConstraint .

limitToLast(limit)

Creates a QueryLimitConstraint that only returns the last matching documents.

You must specify at least one orderBy clause for limitToLast queries, otherwise an exception will be thrown during execution.

Signature:

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

Paramètres

Retour:

QueryLimitConstraint

The created QueryLimitConstraint .

function(logLevel, ...)

setLogLevel(logLevel)

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

Signature:

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

Paramètres

Retour:

vide

function(n, ...)

increment(n)

Returns a special value that can be used with setDoc() or updateDoc() that tells the server to increment the field's current value by the given value.

If either the operand or the current field value uses floating point precision, all arithmetic follows IEEE 754 semantics. If both values are integers, values outside of JavaScript's safe number range ( Number.MIN_SAFE_INTEGER to Number.MAX_SAFE_INTEGER ) are also subject to precision loss. Furthermore, once processed by the Firestore backend, all integer operations are capped between -2^63 and 2^63-1.

If the current field value is not of type number , or if the field does not yet exist, the transformation sets the field to the given value.

Signature:

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

Paramètres

Retour:

FieldValue

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

function(query, ...)

getAggregateFromServer(query, aggregateSpec)

Calculates the specified aggregations over the documents in the result set of the given query without actually downloading the documents.

Using this function to perform aggregations is efficient because only the final aggregation values, not the documents' data, are downloaded. This function can perform aggregations of the documents in cases where the result set is prohibitively large to download entirely (thousands of documents).

The result received from the server is presented, unaltered, without considering any local state. That is, documents in the local cache are not taken into consideration, neither are local modifications not yet synchronized with the server. Previously-downloaded results, if any, are not used. Every invocation of this function necessarily involves a round trip to the server.

Signature:

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

Paramètres

Retour:

Promise< AggregateQuerySnapshot <AggregateSpecType, AppModelType, DbModelType>>

Exemple

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

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

getCountFromServer(query)

Calculates the number of documents in the result set of the given query without actually downloading the documents.

Using this function to count the documents is efficient because only the final count, not the documents' data, is downloaded. This function can count the documents in cases where the result set is prohibitively large to download entirely (thousands of documents).

The result received from the server is presented, unaltered, without considering any local state. That is, documents in the local cache are not taken into consideration, neither are local modifications not yet synchronized with the server. Previously-downloaded results, if any, are not used. Every invocation of this function necessarily involves a round trip to the server.

Signature:

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

Paramètres

Retour:

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

A Promise that will be resolved with the count; the count can be retrieved from snapshot.data().count , where snapshot is the AggregateQuerySnapshot to which the returned Promise resolves.

getDocs(query)

Executes the query and returns the results as a QuerySnapshot .

Signature:

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

Paramètres

Retour:

Promise< QuerySnapshot <AppModelType, DbModelType>>

A Promise that will be resolved with the results of the query.

getDocsFromCache(query)

Executes the query and returns the results as a QuerySnapshot from cache. Returns an empty result set if no documents matching the query are currently cached.

Signature:

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

Paramètres

Retour:

Promise< QuerySnapshot <AppModelType, DbModelType>>

A Promise that will be resolved with the results of the query.

getDocsFromServer(query)

Executes the query and returns the results as a QuerySnapshot from the server. Returns an error if the network is not available.

Signature:

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

Paramètres

Retour:

Promise< QuerySnapshot <AppModelType, DbModelType>>

A Promise that will be resolved with the results of the query.

onSnapshot(query, observer)

Attaches a listener for QuerySnapshot events. You may either pass individual onNext and onError callbacks or pass a single observer object with next and error callbacks. The listener can be cancelled by calling the function that is returned when onSnapshot is called.

NOTE: Although an onCompletion callback can be provided, it will never be called because the snapshot stream is never-ending.

Signature:

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;

Paramètres

Retour:

Se désabonner

An unsubscribe function that can be called to cancel the snapshot listener.

onSnapshot(query, options, observer)

Attaches a listener for QuerySnapshot events. You may either pass individual onNext and onError callbacks or pass a single observer object with next and error callbacks. The listener can be cancelled by calling the function that is returned when onSnapshot is called.

NOTE: Although an onCompletion callback can be provided, it will never be called because the snapshot stream is never-ending.

Signature:

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;

Paramètres

Retour:

Se désabonner

An unsubscribe function that can be called to cancel the snapshot listener.

onSnapshot(query, onNext, onError, onCompletion)

Attaches a listener for QuerySnapshot events. You may either pass individual onNext and onError callbacks or pass a single observer object with next and error callbacks. The listener can be cancelled by calling the function that is returned when onSnapshot is called.

NOTE: Although an onCompletion callback can be provided, it will never be called because the snapshot stream is never-ending.

Signature:

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;

Paramètres

Retour:

Se désabonner

An unsubscribe function that can be called to cancel the snapshot listener.

onSnapshot(query, options, onNext, onError, onCompletion)

Attaches a listener for QuerySnapshot events. You may either pass individual onNext and onError callbacks or pass a single observer object with next and error callbacks. The listener can be cancelled by calling the function that is returned when onSnapshot is called.

NOTE: Although an onCompletion callback can be provided, it will never be called because the snapshot stream is never-ending.

Signature:

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;

Paramètres

Retour:

Se désabonner

An unsubscribe function that can be called to cancel the snapshot listener.

query(query, compositeFilter, queryConstraints)

Creates a new immutable instance of Query that is extended to also include additional query constraints.

Signature:

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

Paramètres

Retour:

Requête <AppModelType, DbModelType>

Des exceptions

if any of the provided query constraints cannot be combined with the existing or new constraints.

query(query, queryConstraints)

Creates a new immutable instance of Query that is extended to also include additional query constraints.

Signature:

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

Paramètres

Retour:

Requête <AppModelType, DbModelType>

Des exceptions

if any of the provided query constraints cannot be combined with the existing or new constraints.

function(queryConstraints, ...)

and(queryConstraints)

Creates a new QueryCompositeFilterConstraint that is a conjunction of the given filter constraints. A conjunction filter includes a document if it satisfies all of the given filters.

Signature:

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

Paramètres

Retour:

QueryCompositeFilterConstraint

The newly created QueryCompositeFilterConstraint .

or(queryConstraints)

Creates a new QueryCompositeFilterConstraint that is a disjunction of the given filter constraints. A disjunction filter includes a document if it satisfies any of the given filters.

Signature:

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

Paramètres

Retour:

QueryCompositeFilterConstraint

The newly created QueryCompositeFilterConstraint .

function(reference, ...)

addDoc(reference, data)

Add a new document to specified CollectionReference with the given data, assigning it a document ID automatically.

Signature:

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

Paramètres

Retour:

Promise< DocumentReference <AppModelType, DbModelType>>

A Promise resolved with a DocumentReference pointing to the newly created document after it has been written to the backend (Note that it won't resolve while you're offline).

collection(reference, path, pathSegments)

Gets a CollectionReference instance that refers to a subcollection of reference at the the specified relative path.

Signature:

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

Paramètres

Retour:

CollectionReference < DocumentData , DocumentData >

The CollectionReference instance.

Des exceptions

If the final path has an even number of segments and does not point to a collection.

collection(reference, path, pathSegments)

Gets a CollectionReference instance that refers to a subcollection of reference at the the specified relative path.

Signature:

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

Paramètres

Retour:

CollectionReference < DocumentData , DocumentData >

The CollectionReference instance.

Des exceptions

If the final path has an even number of segments and does not point to a collection.

deleteDoc(reference)

Deletes the document referred to by the specified DocumentReference .

Signature:

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

Paramètres

Retour:

Promise<void>

A Promise resolved once the document has been successfully deleted from the backend (note that it won't resolve while you're offline).

doc(reference, path, pathSegments)

Gets a DocumentReference instance that refers to a document within reference at the specified relative path. If no path is specified, an automatically-generated unique ID will be used for the returned DocumentReference .

Signature:

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

Paramètres

Retour:

Référence de document <AppModelType, DbModelType>

The DocumentReference instance.

Des exceptions

If the final path has an odd number of segments and does not point to a document.

doc(reference, path, pathSegments)

Gets a DocumentReference instance that refers to a document within reference at the specified relative path.

Signature:

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

Paramètres

Retour:

Référence de document < DocumentData , DocumentData >

The DocumentReference instance.

Des exceptions

If the final path has an odd number of segments and does not point to a document.

getDoc(reference)

Reads the document referred to by this DocumentReference .

Signature:

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

Paramètres

Retour:

Promise< DocumentSnapshot <AppModelType, DbModelType>>

A Promise resolved with a DocumentSnapshot containing the current document contents.

getDocFromCache(reference)

Reads the document referred to by this DocumentReference from cache. Returns an error if the document is not currently cached.

Signature:

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

Paramètres

Retour:

Promise< DocumentSnapshot <AppModelType, DbModelType>>

A Promise resolved with a DocumentSnapshot containing the current document contents.

getDocFromServer(reference)

Reads the document referred to by this DocumentReference from the server. Returns an error if the network is not available.

Signature:

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

Paramètres

Retour:

Promise< DocumentSnapshot <AppModelType, DbModelType>>

A Promise resolved with a DocumentSnapshot containing the current document contents.

onSnapshot(reference, observer)

Attaches a listener for DocumentSnapshot events. You may either pass individual onNext and onError callbacks or pass a single observer object with next and error callbacks.

NOTE: Although an onCompletion callback can be provided, it will never be called because the snapshot stream is never-ending.

Signature:

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;

Paramètres

Retour:

Se désabonner

An unsubscribe function that can be called to cancel the snapshot listener.

onSnapshot(reference, options, observer)

Attaches a listener for DocumentSnapshot events. You may either pass individual onNext and onError callbacks or pass a single observer object with next and error callbacks.

NOTE: Although an onCompletion callback can be provided, it will never be called because the snapshot stream is never-ending.

Signature:

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;

Paramètres

Retour:

Se désabonner

An unsubscribe function that can be called to cancel the snapshot listener.

onSnapshot(reference, onNext, onError, onCompletion)

Attaches a listener for DocumentSnapshot events. You may either pass individual onNext and onError callbacks or pass a single observer object with next and error callbacks.

NOTE: Although an onCompletion callback can be provided, it will never be called because the snapshot stream is never-ending.

Signature:

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;

Paramètres

Retour:

Se désabonner

An unsubscribe function that can be called to cancel the snapshot listener.

onSnapshot(reference, options, onNext, onError, onCompletion)

Attaches a listener for DocumentSnapshot events. You may either pass individual onNext and onError callbacks or pass a single observer object with next and error callbacks.

NOTE: Although an onCompletion callback can be provided, it will never be called because the snapshot stream is never-ending.

Signature:

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;

Paramètres

Retour:

Se désabonner

An unsubscribe function that can be called to cancel the snapshot listener.

setDoc(reference, data)

Writes to the document referred to by this DocumentReference . If the document does not yet exist, it will be created.

Signature:

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

Paramètres

Retour:

Promise<void>

A Promise resolved once the data has been successfully written to the backend (note that it won't resolve while you're offline).

setDoc(reference, data, options)

Writes to the document referred to by the specified DocumentReference . If the document does not yet exist, it will be created. If you provide merge or mergeFields , the provided data can be merged into an existing document.

Signature:

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

Paramètres

Retour:

Promise<void>

A Promise resolved once the data has been successfully written to the backend (note that it won't resolve while you're offline).

updateDoc(reference, data)

Updates fields in the document referred to by the specified DocumentReference . The update will fail if applied to a document that does not exist.

Signature:

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

Paramètres

Retour:

Promise<void>

A Promise resolved once the data has been successfully written to the backend (note that it won't resolve while you're offline).

updateDoc(reference, field, value, moreFieldsAndValues)

Updates fields in the document referred to by the specified DocumentReference The update will fail if applied to a document that does not exist.

Nested fields can be updated by providing dot-separated field path strings or by providing FieldPath objects.

Signature:

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

Paramètres

Retour:

Promise<void>

A Promise resolved once the data has been successfully written to the backend (note that it won't resolve while you're offline).

function(settings, ...)

memoryLocalCache(settings)

Creates an instance of MemoryLocalCache . The instance can be set to FirestoreSettings.cache to tell the SDK which cache layer to use.

Signature:

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

Paramètres

Retour:

MemoryLocalCache

memoryLruGarbageCollector(settings)

Creates an instance of MemoryLruGarbageCollector .

A target size can be specified as part of the setting parameter. The collector will start deleting documents once the cache size exceeds the given size. The default cache size is 40MB (40 * 1024 * 1024 bytes).

Signature:

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

Paramètres

Retour:

MemoryLruGarbageCollector

persistentLocalCache(settings)

Creates an instance of PersistentLocalCache . The instance can be set to FirestoreSettings.cache to tell the SDK which cache layer to use.

Persistent cache cannot be used in a Node.js environment.

Signature:

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

Paramètres

Retour:

PersistentLocalCache

persistentSingleTabManager(settings)

Creates an instance of PersistentSingleTabManager .

Signature:

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

Paramètres

Retour:

PersistentSingleTabManager

function(snapshot, ...)

endAt(snapshot)

Creates a QueryEndAtConstraint that modifies the result set to end at the provided document (inclusive). The end position is relative to the order of the query. The document must contain all of the fields provided in the orderBy of the query.

Signature:

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

Paramètres

Retour:

QueryEndAtConstraint

A QueryEndAtConstraint to pass to query()

endBefore(snapshot)

Creates a QueryEndAtConstraint that modifies the result set to end before the provided document (exclusive). The end position is relative to the order of the query. The document must contain all of the fields provided in the orderBy of the query.

Signature:

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

Paramètres

Retour:

QueryEndAtConstraint

A QueryEndAtConstraint to pass to query()

startAfter(snapshot)

Creates a QueryStartAtConstraint that modifies the result set to start after the provided document (exclusive). The starting position is relative to the order of the query. The document must contain all of the fields provided in the orderBy of the query.

Signature:

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

Paramètres

Retour:

QueryStartAtConstraint

A QueryStartAtConstraint to pass to query()

startAt(snapshot)

Creates a QueryStartAtConstraint that modifies the result set to start at the provided document (inclusive). The starting position is relative to the order of the query. The document must contain all of the fields provided in the orderBy of this query.

Signature:

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

Paramètres

Retour:

QueryStartAtConstraint

A QueryStartAtConstraint to pass to query() .

CACHE_SIZE_UNLIMITED

Constant used to indicate the LRU garbage collection should be disabled. Set this value as the cacheSizeBytes on the settings passed to the Firestore instance.

Signature:

CACHE_SIZE_UNLIMITED = -1

AddPrefixToKeys

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

Signature:

export declare type AddPrefixToKeys<Prefix extends string, T extends Record<string, unknown>> = {
    [K in keyof T & string as `${Prefix}.${K}`]+?: string extends K ? any : T[K];
};

AggregateFieldType

The union of all AggregateField types that are supported by Firestore.

Signature:

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

AggregateSpecData

A type whose keys are taken from an AggregateSpec , and whose values are the result of the aggregation performed by the corresponding AggregateField from the input AggregateSpec .

Signature:

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

AggregateType

Union type representing the aggregate type to be performed.

Signature:

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

ChildUpdateFields

Helper for calculating the nested fields for a given type T1. This is needed to distribute union types such as undefined | {...} (happens for optional props) or {a: A} | {b: B} .

In this use case, V is used to distribute the union types of T[K] on Record , since T[K] is evaluated as an expression and not distributed.

See https://www.typescriptlang.org/docs/handbook/advanced-types.html#distributive-conditional-types

Signature:

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

DocumentChangeType

The type of a DocumentChange may be 'added', 'removed', or 'modified'.

Signature:

export declare type DocumentChangeType = 'added' | 'removed' | 'modified';

FirestoreErrorCode

The set of Firestore status codes. The codes are the same at the ones exposed by gRPC here: https://github.com/grpc/grpc/blob/master/doc/statuscodes.md

Possible values: - 'cancelled': The operation was cancelled (typically by the caller). - 'unknown': Unknown error or an error from a different error domain. - 'invalid-argument': Client specified an invalid argument. Note that this differs from 'failed-precondition'. 'invalid-argument' indicates arguments that are problematic regardless of the state of the system (eg an invalid field name). - 'deadline-exceeded': Deadline expired before operation could complete. For operations that change the state of the system, this error may be returned even if the operation has completed successfully. For example, a successful response from a server could have been delayed long enough for the deadline to expire. - 'not-found': Some requested document was not found. - 'already-exists': Some document that we attempted to create already exists. - 'permission-denied': The caller does not have permission to execute the specified operation. - 'resource-exhausted': Some resource has been exhausted, perhaps a per-user quota, or perhaps the entire file system is out of space. - 'failed-precondition': Operation was rejected because the system is not in a state required for the operation's execution. - 'aborted': The operation was aborted, typically due to a concurrency issue like transaction aborts, etc. - 'out-of-range': Operation was attempted past the valid range. - 'unimplemented': Operation is not implemented or not supported/enabled. - 'internal': Internal errors. Means some invariants expected by underlying system has been broken. If you see one of these errors, something is very broken. - 'unavailable': The service is currently unavailable. This is most likely a transient condition and may be corrected by retrying with a backoff. - 'data-loss': Unrecoverable data loss or corruption. - 'unauthenticated': The request does not have valid authentication credentials for the operation.

Signature:

export declare type FirestoreErrorCode = 'cancelled' | 'unknown' | 'invalid-argument' | 'deadline-exceeded' | 'not-found' | 'already-exists' | 'permission-denied' | 'resource-exhausted' | 'failed-precondition' | 'aborted' | 'out-of-range' | 'unimplemented' | 'internal' | 'unavailable' | 'data-loss' | 'unauthenticated';

FirestoreLocalCache

Union type from all supported SDK cache layer.

Signature:

export declare type FirestoreLocalCache = MemoryLocalCache | PersistentLocalCache;

ListenSource

Describe the source a query listens to.

Set to default to listen to both cache and server changes. Set to cache to listen to changes in cache only.

Signature:

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

MemoryGarbageCollector

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

Signature:

export declare type MemoryGarbageCollector = MemoryEagerGarbageCollector | MemoryLruGarbageCollector;

NestedUpdateFields

For each field (eg 'bar'), find all nested keys (eg { 'bar.baz': T1, 'bar.qux': T2 } ). Intersect them together to make a single map containing all possible keys that are all marked as optional

Signature:

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

OrderByDirection

The direction of a orderBy() clause is specified as 'desc' or 'asc' (descending or ascending).

Signature:

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

PartialWithFieldValue

Similar to Typescript's Partial<T> , but allows nested fields to be omitted and FieldValues to be passed in as property values.

Signature:

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

PersistentTabManager

A union of all available tab managers.

Signature:

export declare type PersistentTabManager = PersistentSingleTabManager | PersistentMultipleTabManager;

Primitif

Primitive types.

Signature:

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

QueryConstraintType

Describes the different query constraints available in this SDK.

Signature:

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

QueryFilterConstraint

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

Signature:

export declare type QueryFilterConstraint = QueryFieldFilterConstraint | QueryCompositeFilterConstraint;

QueryNonFilterConstraint

QueryNonFilterConstraint is a helper union type that represents QueryConstraints which are used to narrow or order the set of documents, but that do not explicitly filter on a document field. QueryNonFilterConstraint s are created by invoking orderBy() , commencer à() , startAfter() , endBefore() , Fin à() , limit() or limitToLast() and can then be passed to query() to create a new query instance that also contains the QueryConstraint .

Signature:

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

SetOptions

An options object that configures the behavior of setDoc() , and calls. These calls can be configured to perform granular merges instead of overwriting the target documents in their entirety by providing a SetOptions with merge: true .

Signature:

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

TaskState

Represents the state of bundle loading tasks.

Both 'Error' and 'Success' are sinking state: task will abort or complete and there will be no more updates after they are reported.

Signature:

export declare type TaskState = 'Error' | 'Running' | 'Success';

UnionToIntersection

Given a union type U = T1 | T2 | ... , returns an intersected type (T1 & T2 & ...) .

Uses distributive conditional types and inference from conditional types. This works because multiple candidates for the same type variable in contra-variant positions causes an intersection type to be inferred. https://www.typescriptlang.org/docs/handbook/advanced-types.html#type-inference-in-conditional-types https://stackoverflow.com/questions/50374908/transform-union-type-to-intersection -taper

Signature:

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

UpdateData

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

Signature:

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

WhereFilterOp

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

Signature:

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

WithFieldValue

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

Signature:

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