Firma:
export declare class DocumentBuilder<Path extends string>
Constructores
| Constructor | Teclas modificadoras | Descripción |
|---|---|---|
| (constructor)(triggerResource, opciones) | Construye una instancia nueva de la clase DocumentBuilder. |
Métodos
| Método | Teclas modificadoras | Descripción |
|---|---|---|
| onCreate(controlador) | Responde solo a las creaciones de documentos. | |
| onDelete(controlador) | Responde solo a las eliminaciones de documentos. | |
| onUpdate(controlador) | Responde solo a las actualizaciones de documentos. | |
| onWrite(controlador) | Responder a todas las escrituras de documentos (creación, actualización o eliminación) |
firestore.DocumentBuilder.(constructor)
Construye una instancia nueva de la clase DocumentBuilder.
Firma:
constructor(triggerResource: () => string, options: DeploymentOptions);
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| Recurso activador | () => cadena | |
| opciones | Opciones de implementación |
firestore.DocumentBuilder.onCreate()
Responde 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 |
|---|---|---|
| handler | (instantánea: QueryDocumentSnapshot, contexto: EventContext<ParamsOf<Path>>) => Promesa como<cualquiera> | cualquiera |
Muestra:
CloudFunction<QueryDocumentSnapshot>
firestore.DocumentBuilder.onDelete()
Responde 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 |
|---|---|---|
| handler | (instantánea: QueryDocumentSnapshot, contexto: EventContext<ParamsOf<Path>>) => Promesa como<cualquiera> | cualquiera |
Muestra:
CloudFunction<QueryDocumentSnapshot>
firestore.DocumentBuilder.onUpdate()
Responde 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 |
|---|---|---|
| handler | (cambio: Cambiar<QueryDocumentSnapshot>, contexto: EventContext<ParamsOf<Path>>) => Promesa como<cualquiera> | cualquiera |
Muestra:
CloudFunction<Cambio<QueryDocumentSnapshot>>
firestore.DocumentBuilder.onWrite()
Responder a todas las escrituras de documentos (creación, actualización o eliminación)
Firma:
onWrite(handler: (change: Change<DocumentSnapshot>, context: EventContext<ParamsOf<Path>>) => PromiseLike<any> | any): CloudFunction<Change<DocumentSnapshot>>;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| handler | (cambio: Change<DocumentSnapshot>, contexto: EventContext<ParamsOf<Path>>) => Promesa como<cualquiera> | cualquiera |
Muestra:
CloudFunction<Cambio<DocumentSnapshot>>