firestore.DocumentBuilder class

Firma:

export declare class DocumentBuilder<Path extends string> 

Constructores

Constructor modificadores Descripción
(constructor)(triggerResource, opciones) Construye una nueva instancia de la clase DocumentBuilder

Métodos

Método modificadores Descripción
onCreate (controlador) Responda solo a las creaciones de documentos.
onDelete(manejador) Responda solo a las eliminaciones de documentos.
onUpdate(manejador) Responda solo a las actualizaciones de documentos.
onWrite (controlador) Responda a todas las escrituras de documentos (creaciones, actualizaciones o eliminaciones).

firestore.DocumentBuilder.(constructor)

Construye una nueva instancia de la clase DocumentBuilder

Firma:

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

Parámetros

Parámetro Tipo Descripción
disparadorRecurso () => cadena
opciones Opciones de implementación

firestore.DocumentBuilder.onCreate()

Responda solo a las creaciones de documentos.

Firma:

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

Parámetros

Parámetro Tipo Descripción
manipulador (instantánea: QueryDocumentSnapshot , contexto: contexto de evento <ParamsOf<Path>>) => PromiseLike<any> | cualquier

Devoluciones:

CloudFunction < ConsultaDocumentoInstantánea >

firestore.DocumentBuilder.onDelete()

Responda solo a las eliminaciones de documentos.

Firma:

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

Parámetros

Parámetro Tipo Descripción
manipulador (instantánea: QueryDocumentSnapshot , contexto: contexto de evento <ParamsOf<Path>>) => PromiseLike<any> | cualquier

Devoluciones:

CloudFunction < ConsultaDocumentoInstantánea >

firestore.DocumentBuilder.onUpdate()

Responda solo a las actualizaciones de documentos.

Firma:

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

Parámetros

Parámetro Tipo Descripción
manipulador (cambiar: Cambiar < ConsultaDocumentoInstantánea >, contexto: EventContext <ParamsOf<Path>>) => PromiseLike<any> | cualquier

Devoluciones:

CloudFunction < Cambiar < ConsultaDocumentoInstantánea >>

firestore.DocumentBuilder.onWrite()

Responda a todas las escrituras de documentos (creaciones, actualizaciones o eliminaciones).

Firma:

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

Parámetros

Parámetro Tipo Descripción
manipulador (cambiar: Cambiar < Instantánea del documento >, contexto: EventContext <ParamsOf<Path>>) => PromiseLike<any> | cualquier

Devoluciones:

CloudFunction < Cambiar < Instantánea del documento >>