firestore.DocumentBuilder class

Signature:

export declare class DocumentBuilder<Path extends string> 

Constructeurs

Constructeur Modificateurs Description
(constructeur)(triggerResource, options) Construit une nouvelle instance de la classe DocumentBuilder

Méthodes

Méthode Modificateurs Description
onCreate (gestionnaire) Répondez uniquement aux créations de documents.
onDelete (gestionnaire) Répondez uniquement aux suppressions de documents.
onUpdate (gestionnaire) Répondez uniquement aux mises à jour des documents.
onWrite (gestionnaire) Répondez à toutes les écritures de documents (créations, mises à jour ou suppressions).

firestore.DocumentBuilder.(constructeur)

Construit une nouvelle instance de la classe DocumentBuilder

Signature:

constructor(triggerResource: () => string, options: DeploymentOptions);

Paramètres

Paramètre Taper Description
triggerResource () => chaîne
choix Options de déploiement

firestore.DocumentBuilder.onCreate()

Répondez uniquement aux créations de documents.

Signature:

onCreate(handler: (snapshot: QueryDocumentSnapshot, context: EventContext<ParamsOf<Path>>) => PromiseLike<any> | any): CloudFunction<QueryDocumentSnapshot>;

Paramètres

Paramètre Taper Description
gestionnaire (instantané : QueryDocumentSnapshot , contexte : EventContext <ParamsOf<Path>>) => PromiseLike<any> | n'importe lequel

Retour:

Fonction Cloud < RequêteDocumentSnapshot >

firestore.DocumentBuilder.onDelete()

Répondez uniquement aux suppressions de documents.

Signature:

onDelete(handler: (snapshot: QueryDocumentSnapshot, context: EventContext<ParamsOf<Path>>) => PromiseLike<any> | any): CloudFunction<QueryDocumentSnapshot>;

Paramètres

Paramètre Taper Description
gestionnaire (instantané : QueryDocumentSnapshot , contexte : EventContext <ParamsOf<Path>>) => PromiseLike<any> | n'importe lequel

Retour:

Fonction Cloud < RequêteDocumentSnapshot >

firestore.DocumentBuilder.onUpdate()

Répondez uniquement aux mises à jour des documents.

Signature:

onUpdate(handler: (change: Change<QueryDocumentSnapshot>, context: EventContext<ParamsOf<Path>>) => PromiseLike<any> | any): CloudFunction<Change<QueryDocumentSnapshot>>;

Paramètres

Paramètre Taper Description
gestionnaire (changement : changement < RequêteDocumentSnapshot >, contexte : EventContext <ParamsOf<Path>>) => PromiseLike<any> | n'importe lequel

Retour:

Fonction Cloud < Changer < RequêteDocumentSnapshot >>

firestore.DocumentBuilder.onWrite()

Répondez à toutes les écritures de documents (créations, mises à jour ou suppressions).

Signature:

onWrite(handler: (change: Change<DocumentSnapshot>, context: EventContext<ParamsOf<Path>>) => PromiseLike<any> | any): CloudFunction<Change<DocumentSnapshot>>;

Paramètres

Paramètre Taper Description
gestionnaire (changement : changement < Instantané du document >, contexte : EventContext <ParamsOf<Path>>) => PromiseLike<any> | n'importe lequel

Retour:

Fonction Cloud < Changer < Instantané du document >>