@firebase/firestore/lite

Les fonctions

Des classes

Interfaces

Tapez les alias

fonction(application, ...)

getFirestore (application)

Renvoie l'instance Firestore par défaut existante associée à la FirebaseApp fournie . Si aucune instance n'existe, initialise une nouvelle instance avec les paramètres par défaut.

Signature:

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

Paramètres

Retour:

Firestore

L'instance Firestore de l'application fournie.

getFirestore (application, ID de base de données)

Cette API est fournie en avant-première pour les 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 existante associée à la FirebaseApp fournie . Si aucune instance n'existe, initialise une nouvelle instance avec les paramètres par défaut.

Signature:

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

Paramètres

Retour:

Firestore

L'instance Firestore de l'application fournie.

initializeFirestore (application, paramètres)

Initialise une nouvelle instance de Cloud 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: Settings): Firestore;

Paramètres

Retour:

Firestore

Une instance Firestore nouvellement initialisée.

initializeFirestore (application, paramètres, identifiant de base de données)

Cette API est fournie en avant-première pour les développeurs et peut changer en fonction des commentaires que nous recevons. N'utilisez pas cette API dans un environnement de production.

Initialise une nouvelle instance de Cloud 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: Settings, databaseId?: string): Firestore;

Paramètres

Retour:

Firestore

Une instance Firestore nouvellement initialisée.

fonction (firestore, ...)

collection (firestore, chemin, cheminSegments)

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

Signature:

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

Paramètres

Retour:

CollectionRéférence < DocumentDonnées , DocumentData >

Instance CollectionReference .

Des exceptions

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

collectionGroup(firestore, collectionId)

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

Signature:

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

Paramètres

Retour:

Requête < DocumentDonnées , DocumentData >

La Query créée .

connectFirestoreEmulator (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

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.

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.

Terminer (Firestore)

Termine l'instance Firestore fournie.

Après avoir appelé terminate() seules les fonctions clearIndexedDbPersistence() peuvent être utilisées. Toute autre fonction lancera une FirestoreError . La terminaison n'annule aucune écriture en attente, et toute promesse qui attend une réponse du serveur ne sera pas résolue.

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

Signature:

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

Paramètres

Retour:

Promesse<vide>

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

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.

Le résultat de ces écritures ne sera reflété que dans les lectures de documents qui se produisent après la résolution de la promesse retournée. Si le client est hors ligne, l'écriture échoue. Si vous souhaitez voir des modifications locales ou des écritures de tampon jusqu'à ce que le client soit en ligne, utilisez le SDK complet de Firestore.

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 de l'application fournie.

serveurTimestamp()

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 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 Firestore de l'application fournie.

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)

Renvoie une valeur spéciale qui peut être utilisée avec SetDoc () ou UpdatedOC () qui indique au serveur d'union les éléments donnés avec n'importe quelle valeur de tableau qui existe déjà sur le serveur. Chaque élément spécifié qui n'existe pas déjà dans le tableau sera ajouté à la fin. Si le champ modifié n'est pas déjà un tableau, il sera écrasé avec un tableau contenant exactement les éléments spécifiés.

Signature:

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

Paramètres

Retour:

Surface

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

fonction (champ, ...)

moyen (champ)

Créez un objet AggregateField qui peut être utilisé pour calculer la moyenne d'un champ spécifié sur une gamme de documents dans l'ensemble de résultats d'une requête.

Signature:

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

Paramètres

Retour:

Agrégatfield <nombre | null>

somme (champ)

Créez un objet AggregateField qui peut être utilisé pour calculer la somme d'un champ spécifié sur une gamme de documents dans l'ensemble de résultats d'une requête.

Signature:

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

Paramètres

Retour:

Agrégatfield <graisser>

Fonction (FieldPath, ...)

OrderBy (FieldPath, DirectionTR)

Crée un QueryOrderByConstraint qui trie le résultat de la requête par le champ spécifié, éventuellement par ordre décroissant au lieu de monter.

Signature:

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

Paramètres

Retour:

QueryOrderByConstraint

La question créée .

Où (FieldPath, Opstr, valeur)

Crée un QueryFieldFilterConstraint qui applique que les documents doivent contenir le champ spécifié et que la valeur doit satisfaire la contrainte de relation fournie.

Signature:

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

Paramètres

Retour:

QueryFieldFilterConstraint

Le CreatedFieldFilterConstraint .

Fonction (FieldValues, ...)

Endat (FieldValues)

Crée un QueryendatConstraint qui modifie le résultat des résultats pour se terminer aux champs fournis par rapport à l'ordre de la requête. L'ordre des valeurs de champ doit correspondre à l'ordre de l'ordre par les clauses de la requête.

Signature:

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

Paramètres

Retour:

Queryendatconstraint

Une questionnatConstraint à passer à query()

endbefore (fieldvalues)

Crée un QueryendatConstraint qui modifie le résultat des résultats pour se terminer devant les champs fournis par rapport à l'ordre de la requête. L'ordre des valeurs de champ doit correspondre à l'ordre de l'ordre par les clauses de la requête.

Signature:

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

Paramètres

Retour:

Queryendatconstraint

Une questionnatConstraint à passer à query()

StartAfter (FieldValues)

Crée un QueryStartAtConstraint qui modifie l'ensemble de résultats pour démarrer après les champs fournis par rapport à l'ordre de la requête. L'ordre des valeurs de champ doit correspondre à l'ordre de l'ordre par les clauses de la requête.

Signature:

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

Paramètres

Retour:

QuerystartatConstraint

Un questionnaire queryStArtArtraine à passer à query()

Startat (FieldValues)

Crée un QueryStartAtConstraint qui modifie l'ensemble de résultats pour démarrer aux champs fournis par rapport à l'ordre de la requête. L'ordre des valeurs de champ doit correspondre à l'ordre de l'ordre par les clauses de la requête.

Signature:

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

Paramètres

Retour:

QuerystartatConstraint

Un questionnaire queryStArtArtraine à passer à query() .

Fonction (à gauche, ...)

agrégateFieldEqual (à gauche, à droite)

Compare deux 'Aggregatefield `Instances pour l'égalité.

Signature:

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

Paramètres

Retour:

booléen

agrégatequerysnapshotequal (à gauche, à droite)

Compare deux instances AggregateQuerySnapshot pour l'égalité.

Deux instances AggregateQuerySnapshot sont considérées comme "égales" si elles ont des requêtes sous-jacentes qui se comparent égales et les mêmes données.

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 si les objets sont "égaux", tels que définis ci-dessus, ou false sinon.

Queryequal (à gauche, à droite)

Renvoie True si les requêtes fournies pointent vers la même collection et appliquent les mêmes contraintes.

Signature:

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

Paramètres

Retour:

booléen

Vrai si les références pointent vers le même emplacement dans la même base de données Firestore.

Rebelle (à gauche, à droite)

Renvoie True si les références fournies sont égales.

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

Vrai si les références pointent vers le même emplacement dans la même base de données Firestore.

Snapshotequal (à gauche, à droite)

Renvoie True si les instantanés fournis sont égaux.

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

vrai si les instantanés sont égaux.

fonction(limite, ...)

limite (limite)

Crée une question de la construction qui ne renvoie que les premiers documents correspondants.

Signature:

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

Paramètres

Retour:

Requérir de la construction

La question créée .

limiteVersDernier(limite)

Crée une question de la construction qui ne renvoie que les derniers documents correspondants.

Vous devez spécifier au moins une clause orderBy pour les requêtes limitToLast , sinon une exception sera lancée lors de l'exécution.

Signature:

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

Paramètres

Retour:

Requérir de la construction

La question créée .

Fonction (LoGlevel, ...)

setLoglevel (Loglevel)

Définit la verbosité des journaux Cloud Firestore (débogage, erreur ou silencieux).

Signature:

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

Paramètres

Retour:

vide

fonction (n, ...)

incrément(n)

Renvoie une valeur spéciale qui peut être utilisée avec SetDoc () ou UpdatedOC () qui indique au serveur d'incrémenter la valeur actuelle du champ par la valeur donnée.

Si l'opérande ou la valeur de champ actuelle utilise une précision de point flottante, tout arithmétique suit la sémantique IEEE 754. Si les deux valeurs sont des entiers, des valeurs en dehors de la plage de nombres sûres de JavaScript ( Number.MIN_SAFE_INTEGER à Number.MAX_SAFE_INTEGER ) sont également soumis à une perte de précision. De plus, une fois traités par le backend Firestore, toutes les opérations entières sont plafonnées entre -2 ^ 63 et 2 ^ 63-1.

Si la valeur de champ actuelle n'est pas du number de type , ou si le champ n'existe pas encore, la transformation définit le champ vers la valeur donnée.

Signature:

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

Paramètres

Retour:

Surface

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

fonction(requête, ...)

getaggregate (requête, agrégatespec)

Calcule les agrégations spécifiées sur les documents dans l'ensemble de résultats de la requête donnée sans télécharger les documents.

L'utilisation de cette fonction pour effectuer des agrégations est efficace car seules les valeurs d'agrégation finales, et non les données des documents, sont téléchargées. Cette fonction peut effectuer des agrégations des documents dans les cas où l'ensemble de résultats est prohibitif de télécharger entièrement (des milliers de documents).

Signature:

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

Paramètres

Retour:

Promesse < agrégatequerysnapshot <Agrégatespectype, appmodelType, dbModelType >>

Exemple

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 (requête)

Calcule le nombre de documents dans l'ensemble de résultats de la requête donnée sans télécharger les documents.

L'utilisation de cette fonction pour compter les documents est efficace car seul le nombre final, et non les données des documents, est téléchargé. Cette fonction peut compter les documents dans les cas où l'ensemble de résultats est prohibitif de télécharger entièrement (des milliers de documents).

Signature:

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

Paramètres

Retour:

Promesse < agrégatequerysnapshot <{Count: AggregateField <bumber>; }, AppmodelType, dbModelType >>

Une promesse qui sera résolue avec le décompte; Le nombre peut être récupéré à partir de snapshot.data().count , où snapshot est le AggregateQuerySnapshot à lequel la promesse retournée se résout.

getDocs (requête)

Exécute la requête et renvoie les résultats en tant que questionnaire .

Toutes les requêtes sont exécutées directement par le serveur, même si la requête était précédemment exécutée. Les modifications récentes ne se reflètent que dans les résultats récupérés que s'ils ont déjà été appliqués par le backend. Si le client est hors ligne, l'opération échoue. Pour voir les résultats précédemment mis en cache et les modifications locales, utilisez le SDK complet Firestore.

Signature:

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

Paramètres

Retour:

Promesse < queerysnapshot <AppmodelType, dbModelType >>

Une promesse qui sera résolue avec les résultats de la requête.

requête (requête, compositefilter, requêtes)

Crée une nouvelle instance immuable de Query qui est étendue pour inclure également des contraintes de requête supplémentaires.

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

si l'une des contraintes de requête fournies ne peut pas être combinée avec les contraintes existantes ou nouvelles.

requête (requête, requêteConstraints)

Crée une nouvelle instance immuable de Query qui est étendue pour inclure également des contraintes de requête supplémentaires.

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

si l'une des contraintes de requête fournies ne peut pas être combinée avec les contraintes existantes ou nouvelles.

Fonction (QueryConstraints, ...)

et (requêtes Constraints)

Crée un nouveau QueryCompositeFilterConstraint qui est une conjonction des contraintes de filtre donné. Un filtre de conjonction comprend un document s'il satisfait tous les filtres donnés.

Signature:

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

Paramètres

Retour:

QueryCompositeFilterConstraint

La nouvelle querycompositeFilterConstraint .

ou (questionnois)

Crée une nouvelle Coutraistraint QueryCompositeFilter qui est une disjonction des contraintes de filtre données. Un filtre de disjonction comprend un document s'il satisfait l'un des filtres donnés.

Signature:

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

Paramètres

Retour:

QueryCompositeFilterConstraint

La nouvelle querycompositeFilterConstraint .

fonction (référence, ...)

addDoc (référence, données)

Ajoutez un nouveau document à CollectionReference spécifiée avec les données données, en lui attribuant automatiquement un ID de document.

Le résultat de cette écriture ne sera reflété que dans les lectures de documents qui se produisent après la résolution de la promesse retournée. Si le client est hors ligne, l'écriture échoue. Si vous souhaitez voir des modifications locales ou des écritures de tampon jusqu'à ce que le client soit en ligne, utilisez le SDK complet de Firestore.

Signature:

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

Paramètres

Retour:

Promesse < documentReference <AppmodelType, dbModelType >>

Une Promise résolue avec une DocumentReference pointant vers le document nouvellement créé après avoir été écrit sur le backend.

Des exceptions

Erreur - Si l'entrée fournie n'est pas un document Firestore valide.

Collection (référence, chemin, pathsegments)

Obtient une instance CollectionReference qui fait référence à une sous-collection de reference au chemin relatif spécifié.

Signature:

export declare function collection<AppModelType, DbModelType extends DocumentData>(reference: CollectionReference<AppModelType, DbModelType>, 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.

Collection (référence, chemin, pathsegments)

Obtient une instance CollectionReference qui fait référence à une sous-collection de reference au chemin relatif spécifié.

Signature:

export declare function collection<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, 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.

Deletedoc (référence)

Supprime le document mentionné par le DocumentReference spécifié .

La suppression ne sera reflétée que dans les lectures de documents qui se produisent après la résolution de la promesse retournée. Si le client est hors ligne, la suppression échoue. Si vous souhaitez voir des modifications locales ou des écritures de tampon jusqu'à ce que le client soit en ligne, utilisez le SDK complet de Firestore.

Signature:

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

Paramètres

Retour:

Promesse<vide>

Une Promise résolue une fois que le document a été supprimé avec succès du backend.

doc (référence, chemin, pathsegments)

Obtient une instance DocumentReference qui fait référence à un document dans la reference sur le chemin relatif spécifié. Si aucun chemin n'est spécifié, un ID unique généré automatiquement sera utilisé pour le DocumentReference renvoyé .

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>

L'instance DocumentReference .

Des exceptions

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

doc (référence, chemin, pathsegments)

Obtient une instance DocumentReference qui fait référence à un document dans la reference sur le chemin relatif spécifié.

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 >

L'instance DocumentReference .

Des exceptions

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

getDoc (référence)

Lit le document mentionné par la référence de document spécifiée.

Tous les documents sont directement récupérés à partir du serveur, même si le document a été précédemment lu ou modifié. Les modifications récentes se reflètent dans les DocumentSnapshot récupérés que si elles ont déjà été appliquées par le backend. Si le client est hors ligne, la lecture échoue. Si vous aimez utiliser la mise en cache ou voir les modifications locales, veuillez utiliser le SDK complet de Firestore.

Signature:

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

Paramètres

Retour:

Promesse < documents napshot <AppmodelType, dbModelType >>

Une promesse résolue avec un DocumentSnapshot contenant le contenu du document actuel.

setDoc (référence, données)

Écrit au document mentionné par le DocumentReference spécifié . Si le document n'existe pas encore, il sera créé.

Le résultat de cette écriture ne sera reflété que dans les lectures de documents qui se produisent après la résolution de la promesse retournée. Si le client est hors ligne, l'écriture échoue. Si vous souhaitez voir des modifications locales ou des écritures de tampon jusqu'à ce que le client soit en ligne, utilisez le SDK complet de Firestore.

Signature:

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

Paramètres

Retour:

Promesse<vide>

Une Promise résolue une fois que les données ont été écrites avec succès sur le backend.

Des exceptions

Erreur - Si l'entrée fournie n'est pas un document Firestore valide.

setDoc (référence, données, options)

Écrit au document mentionné par le DocumentReference spécifié . Si le document n'existe pas encore, il sera créé. Si vous fournissez des champs merge ou mergeFields , les données fournies peuvent être fusionnées dans un document existant.

Le résultat de cette écriture ne sera reflété que dans les lectures de documents qui se produisent après la résolution de la promesse retournée. Si le client est hors ligne, l'écriture échoue. Si vous souhaitez voir des modifications locales ou des écritures de tampon jusqu'à ce que le client soit en ligne, utilisez le SDK complet de Firestore.

Signature:

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

Paramètres

Retour:

Promesse<vide>

Une Promise résolue une fois que les données ont été écrites avec succès sur le backend.

Des exceptions

Erreur - Si l'entrée fournie n'est pas un document Firestore valide.

UpdatedOC (référence, données)

Mise à jour les champs du document mentionné par le DocumentReference spécifié . La mise à jour échouera si elle est appliquée à un document qui n'existe pas.

Le résultat de cette mise à jour ne sera reflété que dans les lectures de documents qui se produisent après la résolution de la promesse retournée. Si le client est hors ligne, la mise à jour échoue. Si vous souhaitez voir des modifications locales ou des écritures de tampon jusqu'à ce que le client soit en ligne, utilisez le SDK complet de Firestore.

Signature:

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

Paramètres

Retour:

Promesse<vide>

Une Promise résolue une fois que les données ont été écrites avec succès sur le backend.

Des exceptions

Erreur - Si l'entrée fournie n'est pas des données Firestore valides.

UpdatedOC (référence, champ, valeur, morefieldsandvalues)

Mette à jour les champs du document mentionné par le DocumentReference spécifié La mise à jour échouera si elle est appliquée à un document qui n'existe pas.

Les champs imbriqués peuvent être mis à jour en fournissant des chaînes de chemin de champ séparées par DOT ou en fournissant des objets FieldPath .

Le résultat de cette mise à jour ne sera reflété que dans les lectures de documents qui se produisent après la résolution de la promesse retournée. Si le client est hors ligne, la mise à jour échoue. Si vous souhaitez voir des modifications locales ou des écritures de tampon jusqu'à ce que le client soit en ligne, utilisez le SDK complet de Firestore.

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:

Promesse<vide>

Une Promise résolue une fois que les données ont été écrites avec succès sur le backend.

Des exceptions

Erreur - Si l'entrée fournie n'est pas des données Firestore valides.

fonction (instantané, ...)

endat (instantané)

Crée un QueryendatConstraint qui modifie le jeu de résultats pour se terminer au document fourni (inclusif). La position finale est relative à l'ordre de la requête. Le document doit contenir tous les champs fournis dans l'ordre par la requête.

Signature:

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

Paramètres

Retour:

Queryendatconstraint

Une questionnatConstraint à passer à query()

endbefore (instantané)

Crée un QueryEndatConstraint qui modifie le jeu de résultats pour se terminer avant le document fourni (exclusif). La position finale est relative à l'ordre de la requête. Le document doit contenir tous les champs fournis dans l'ordre par la requête.

Signature:

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

Paramètres

Retour:

Queryendatconstraint

Une questionnatConstraint à passer à query()

startafter (instantané)

Crée un QueryStartAtConstraint qui modifie l'ensemble de résultats pour démarrer après le document fourni (exclusif). La position de départ est relative à l'ordre de la requête. Le document doit contenir tous les champs fournis dans l'ordre par la requête.

Signature:

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

Paramètres

Retour:

QuerystartatConstraint

Un questionnaire queryStArtArtraine à passer à query()

Startat (instantané)

Crée un QueryStartAtConstraint qui modifie l'ensemble de résultats pour démarrer au document fourni (inclusif). La position de départ est relative à l'ordre de la requête. Le document doit contenir tous les champs fournis dans l' orderBy par cette requête.

Signature:

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

Paramètres

Retour:

QuerystartatConstraint

Un questionnaire queryStArtArtraine à passer à query() .

Addprefixtokeys

Renvoie une nouvelle carte où chaque clé est préfixée avec la clé extérieure annexée à un point.

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

Le syndicat de tous les types AggregateField qui sont soutenus par Firestore.

Signature:

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

Agrégats pecdata

Un type dont les clés sont tirées d'un AggregateSpec , et dont les valeurs sont le résultat de l'agrégation effectuée par le AggregateField correspondant à partir de l' AggregateSpec de l'entrée .

Signature:

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

Agrégaterype

Type d'union représentant le type agrégé à effectuer.

Signature:

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

ChildUpdatefields

Aide pour calculer les champs imbriqués pour un type donné T1. Ceci est nécessaire pour distribuer des types d'union tels que undefined | {...} (se produit pour les accessoires facultatifs) ou {a: A} | {b: B} .

Dans ce cas d'utilisation, V est utilisé pour Record les types syndicaux de T[K] , puisque T[K] est évalué comme une expression et non distribué.

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

Signature:

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

FirestoreErrorcode

L'ensemble des codes d'état Firestore. Les codes sont les mêmes chez ceux exposés par GRPC ici: https://github.com/grpc/grpc/blob/master/doc/statucodes.md

Valeurs possibles: - «Annulé»: l'opération a été annulée (généralement par l'appelant). - «Inconnu»: erreur inconnue ou erreur d'un domaine d'erreur différent. - «Argument non valide»: le client a spécifié un argument non valide. Notez que cela diffère de la «précondition échouée». «Argument invalide» indique des arguments problématiques quel que soit l'état du système (par exemple, un nom de champ non valide). - «Date limite-examend»: la date limite a expiré avant que l'opération ne puisse se terminer. Pour les opérations qui modifient l'état du système, cette erreur peut être renvoyée même si l'opération s'est terminée avec succès. Par exemple, une réponse réussie d'un serveur aurait pu être retardée suffisamment longtemps pour que la date limite expire. - «pas-fond»: un document demandé n'a pas été trouvé. - «déjà-existes»: un document que nous avons tenté de créer existe déjà. - «Permission-Denied»: l'appelant n'a pas la permission d'exécuter l'opération spécifiée. - «Ressource-Exhusted»: une ressource a été épuisée, peut-être un quota par utilisateur, ou peut-être que l'ensemble du système de fichiers est hors de l'espace. - «défaillance de la condition de la condition: l'opération a été rejetée car le système n'est pas dans un état requis pour l'exécution de l'opération. - «abandonné»: l'opération a été interrompue, généralement en raison d'un problème de concurrence comme des abandons de transaction, etc. - «hors gamme»: l'opération a été tentée au-delà de la plage valide. - «UNIMPLEMED»: l'opération n'est pas implémentée ou non prise en charge / activée. - «interne»: erreurs internes. Cela signifie que certains invariants attendus par le système sous-jacent ont été brisés. Si vous voyez une de ces erreurs, quelque chose est très brisé. - «indisponible»: le service n'est actuellement pas disponible. Il s'agit très probablement d'une condition transitoire et peut être corrigée en réessayant avec une backoff. - «Data-loss»: perte ou corruption de données irrécupérable. - «non authentifiée»: la demande n'a pas d'identification d'authentification valide pour l'opération.

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

Niché

Pour chaque champ (par exemple 'bar'), trouvez toutes les clés imbriquées (par exemple { 'bar.baz': t1, 'bar.qux': t2 } ). Les croiser ensemble pour créer une seule carte contenant toutes les clés possibles qui sont toutes marquées comme facultatives

Signature:

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

Commander par ladirection

La direction d'une clause OrderBy () est spécifiée sous forme de «desc» ou «ASC» (descendant ou ascendant).

Signature:

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

Partial avec une valeur

Semblable à Partial<T> de TypeScript , mais permet d'omettre les champs imbriqués et les valeurs de champ en tant que valeur des propriétés.

Signature:

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

Primitif

Types primitifs.

Signature:

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

Type de contrainte de requête

Décrit les différentes contraintes de requête disponibles dans ce SDK.

Signature:

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

QueryfilterConstraint

QueryFilterConstraint est un type d'union d'assistance qui représente QueryFieldFilterConstraint et QueryCompositeFilterConstraine .

Signature:

export declare type QueryFilterConstraint = QueryFieldFilterConstraint | QueryCompositeFilterConstraint;

QuerynonfilterConstraint

QueryNonFilterConstraint est un type d'union d'assistance qui représente des conditions de requête qui sont utilisées pour étroiter ou ordonner l'ensemble des documents, mais qui ne filtrent pas explicitement sur un champ de documents. QueryNonFilterConstraint S sont créés en invoquant OrderBy () , commencer à() , startAfter() , finAvant() , Fin à() , limit () ou limitetolast () et peut ensuite être transmis à QueryConstraint () pour créer une nouvelle instance de requête qui contient également .

Signature:

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

Setoptions

Un objet d'options qui configure le comportement de setDoc () et appelle. Ces appels peuvent être configurés pour effectuer des fusions granulaires au lieu d'écraser les documents cibles dans leur intégralité en fournissant une SetOptions avec merge: true .

Signature:

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

Uniontointersection

Étant donné un type d'union U = T1 | T2 | ... , Renvoie un type intersecté (T1 & T2 & ...) .

Utilise des types conditionnels distributifs et l'inférence à partir de types conditionnels. Cela fonctionne parce que plusieurs candidats pour la même variable de type dans des positions contre-variantes provoquent la déduction d'un type d'intersection. https://www.typescriptlang.org/docs/handbook/advanced-types.html#type-inference-in-conditional-types https://stackoverflow.com/questions/50374908/transform-union-type-com/questions/50374908/transform-union-type-com/Questions/50374908/transform-union-type-com/Questions/50374908/transform-union-type-com/Question/50374908/transform-union-type-com/Question/50374908 -taper

Signature:

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

Updatedata

Mettre à jour les données (pour une utilisation avec UpdatedOC () ) qui se compose de chemins de champ (par exemple 'foo' ou 'foo.baz') mappés aux valeurs. Champs qui contiennent des champs de référence des champs dans le document. Les valeurs de champ peuvent être transmises en tant que valeurs de propriété.

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

Les conditions de filtrage dans une clause WHERE () sont spécifiées à l'aide des chaînes '& lt;', '& lt; =', '==', '! =', '& Gt; =', '& gt;', 'Array-Contains' , «In», «Array-Contains-Any» et «Not-in».

Signature:

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

Withfieldvalue

Permet de passer les valeurs de champ en tant que valeur de propriété tout en maintenant la sécurité du type.

Signature:

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