firestore namespace

Les fonctions

Fonction Description
onDocumentCreated (document, gestionnaire) Gestionnaire d'événements qui se déclenche lorsqu'un document est créé dans Firestore.
onDocumentCreated (opts, gestionnaire) Gestionnaire d'événements qui se déclenche lorsqu'un document est créé dans Firestore.
onDocumentDeleted (document, gestionnaire) Gestionnaire d'événements qui se déclenche lorsqu'un document est supprimé dans Firestore.
onDocumentDeleted (opts, gestionnaire) Gestionnaire d'événements qui se déclenche lorsqu'un document est supprimé dans Firestore.
onDocumentUpdated (document, gestionnaire) Gestionnaire d'événements qui se déclenche lorsqu'un document est mis à jour dans Firestore.
onDocumentUpdated (opts, gestionnaire) Gestionnaire d'événements qui se déclenche lorsqu'un document est mis à jour dans Firestore.
onDocumentWritten (document, gestionnaire) Gestionnaire d'événements qui se déclenche lorsqu'un document est créé, mis à jour ou supprimé dans Firestore.
onDocumentWritten (opts, gestionnaire) Gestionnaire d'événements qui se déclenche lorsqu'un document est créé, mis à jour ou supprimé dans Firestore.

Des classes

Classe Description
Changement L'interface Cloud Functions pour les événements qui changent d'état, tels que les événements Realtime Database ou Cloud Firestore onWrite et onUpdate . Pour plus d'informations sur le format utilisé pour construire des objets Change , voir ci-dessous.

Interfaces

Interface Description
Options du document DocumentOptions étend EventHandlerOptions avec le document fourni, la base de données et l'espace de noms facultatifs.
Événement Firestore Un CloudEvent qui contient un DocumentSnapshot ou un Change

Tapez les alias

Tapez l'alias Description
Instantané du document Un instantané de document Firestore
RequêteDocumentSnapshot Un QueryDocumentSnapshot Firestore

firestore.onDocumentCreated()

Gestionnaire d'événements qui se déclenche lorsqu'un document est créé dans Firestore.

Signature:

export declare function onDocumentCreated<Document extends string>(document: Document, handler: (event: FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>) => any | Promise<any>): CloudFunction<FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>>;

Paramètres

Paramètre Taper Description
document Document Le chemin du document Firestore sur lequel déclencher.
gestionnaire (événement : FirestoreEvent < QueryDocumentSnapshot | non défini, ParamsOf <Document>>) => quelconque | Promesse<n'importe lequel> Gestionnaire d'événements qui est exécuté à chaque fois qu'une création Firestore se produit.

Retour:

Fonction Cloud < Événement Firestore < QueryDocumentSnapshot | non défini, ParamsOf <Document>>>

firestore.onDocumentCreated()

Gestionnaire d'événements qui se déclenche lorsqu'un document est créé dans Firestore.

Signature:

export declare function onDocumentCreated<Document extends string>(opts: DocumentOptions<Document>, handler: (event: FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>) => any | Promise<any>): CloudFunction<FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>>;

Paramètres

Paramètre Taper Description
opte Options du document <Document> Options pouvant être définies sur une fonction de gestion d'événements individuelle.
gestionnaire (événement : FirestoreEvent < QueryDocumentSnapshot | non défini, ParamsOf <Document>>) => quelconque | Promesse<n'importe lequel> Gestionnaire d'événements qui est exécuté à chaque fois qu'une création Firestore se produit.

Retour:

Fonction Cloud < Événement Firestore < QueryDocumentSnapshot | non défini, ParamsOf <Document>>>

firestore.onDocumentDeleted()

Gestionnaire d'événements qui se déclenche lorsqu'un document est supprimé dans Firestore.

Signature:

export declare function onDocumentDeleted<Document extends string>(document: Document, handler: (event: FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>) => any | Promise<any>): CloudFunction<FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>>;

Paramètres

Paramètre Taper Description
document Document Le chemin du document Firestore sur lequel déclencher.
gestionnaire (événement : FirestoreEvent < QueryDocumentSnapshot | non défini, ParamsOf <Document>>) => quelconque | Promesse<n'importe lequel> Gestionnaire d'événements qui est exécuté à chaque fois qu'une suppression de Firestore se produit.

Retour:

Fonction Cloud < Événement Firestore < QueryDocumentSnapshot | non défini, ParamsOf <Document>>>

firestore.onDocumentDeleted()

Gestionnaire d'événements qui se déclenche lorsqu'un document est supprimé dans Firestore.

Signature:

export declare function onDocumentDeleted<Document extends string>(opts: DocumentOptions<Document>, handler: (event: FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>) => any | Promise<any>): CloudFunction<FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>>;

Paramètres

Paramètre Taper Description
opte Options du document <Document> Options pouvant être définies sur une fonction de gestion d'événements individuelle.
gestionnaire (événement : FirestoreEvent < QueryDocumentSnapshot | non défini, ParamsOf <Document>>) => quelconque | Promesse<n'importe lequel> Gestionnaire d'événements qui est exécuté à chaque fois qu'une suppression de Firestore se produit.

Retour:

Fonction Cloud < Événement Firestore < QueryDocumentSnapshot | non défini, ParamsOf <Document>>>

firestore.onDocumentUpdated()

Gestionnaire d'événements qui se déclenche lorsqu'un document est mis à jour dans Firestore.

Signature:

export declare function onDocumentUpdated<Document extends string>(document: Document, handler: (event: FirestoreEvent<Change<QueryDocumentSnapshot> | undefined, ParamsOf<Document>>) => any | Promise<any>): CloudFunction<FirestoreEvent<Change<QueryDocumentSnapshot> | undefined, ParamsOf<Document>>>;

Paramètres

Paramètre Taper Description
document Document Le chemin du document Firestore sur lequel déclencher.
gestionnaire (événement : FirestoreEvent < Changer < RequêteDocumentSnapshot > | non défini, ParamsOf <Document>>) => quelconque | Promesse<n'importe lequel> Gestionnaire d'événements qui est exécuté à chaque fois qu'une mise à jour de Firestore se produit.

Retour:

Fonction Cloud < Événement Firestore < Changer < RequêteDocumentSnapshot > | non défini, ParamsOf <Document>>>

firestore.onDocumentUpdated()

Gestionnaire d'événements qui se déclenche lorsqu'un document est mis à jour dans Firestore.

Signature:

export declare function onDocumentUpdated<Document extends string>(opts: DocumentOptions<Document>, handler: (event: FirestoreEvent<Change<QueryDocumentSnapshot> | undefined, ParamsOf<Document>>) => any | Promise<any>): CloudFunction<FirestoreEvent<Change<QueryDocumentSnapshot> | undefined, ParamsOf<Document>>>;

Paramètres

Paramètre Taper Description
opte Options du document <Document> Options pouvant être définies sur une fonction de gestion d'événements individuelle.
gestionnaire (événement : FirestoreEvent < Changer < RequêteDocumentSnapshot > | non défini, ParamsOf <Document>>) => quelconque | Promesse<n'importe lequel> Gestionnaire d'événements qui est exécuté à chaque fois qu'une mise à jour de Firestore se produit.

Retour:

Fonction Cloud < Événement Firestore < Changer < RequêteDocumentSnapshot > | non défini, ParamsOf <Document>>>

firestore.onDocumentWritten()

Gestionnaire d'événements qui se déclenche lorsqu'un document est créé, mis à jour ou supprimé dans Firestore.

Signature:

export declare function onDocumentWritten<Document extends string>(document: Document, handler: (event: FirestoreEvent<Change<DocumentSnapshot> | undefined, ParamsOf<Document>>) => any | Promise<any>): CloudFunction<FirestoreEvent<Change<DocumentSnapshot> | undefined, ParamsOf<Document>>>;

Paramètres

Paramètre Taper Description
document Document Le chemin du document Firestore sur lequel déclencher.
gestionnaire (événement : FirestoreEvent < Changer < Instantané du document > | non défini, ParamsOf <Document>>) => quelconque | Promesse<n'importe lequel> Gestionnaire d'événements qui est exécuté à chaque fois qu'une création, une mise à jour ou une suppression de Firestore se produit.

Retour:

Fonction Cloud < Événement Firestore < Changer < Instantané du document > | non défini, ParamsOf <Document>>>

firestore.onDocumentWritten()

Gestionnaire d'événements qui se déclenche lorsqu'un document est créé, mis à jour ou supprimé dans Firestore.

Signature:

export declare function onDocumentWritten<Document extends string>(opts: DocumentOptions<Document>, handler: (event: FirestoreEvent<Change<DocumentSnapshot> | undefined, ParamsOf<Document>>) => any | Promise<any>): CloudFunction<FirestoreEvent<Change<DocumentSnapshot> | undefined, ParamsOf<Document>>>;

Paramètres

Paramètre Taper Description
opte Options du document <Document> Options pouvant être définies sur une fonction de gestion d'événements individuelle.
gestionnaire (événement : FirestoreEvent < Changer < Instantané du document > | non défini, ParamsOf <Document>>) => quelconque | Promesse<n'importe lequel> Gestionnaire d'événements qui est exécuté à chaque fois qu'une création, une mise à jour ou une suppression de Firestore se produit.

Retour:

Fonction Cloud < Événement Firestore < Changer < Instantané du document > | non défini, ParamsOf <Document>>>

firestore.DocumentSnapshot

Un instantané de document Firestore

Signature:

export type DocumentSnapshot = firestore.DocumentSnapshot;

firestore.QueryDocumentSnapshot

Un QueryDocumentSnapshot Firestore

Signature:

export type QueryDocumentSnapshot = firestore.QueryDocumentSnapshot;