firestore namespace

Funciones

Función Descripción
onDocumentCreated(documento, controlador) Controlador de eventos que se activa cuando se crea un documento en Firestore.
onDocumentCreated(opts, controlador) Controlador de eventos que se activa cuando se crea un documento en Firestore.
onDocumentDeleted(documento, controlador) Controlador de eventos que se activa cuando se elimina un documento en Firestore.
onDocumentDeleted(opts, controlador) Controlador de eventos que se activa cuando se elimina un documento en Firestore.
onDocumentUpdated(documento, controlador) Controlador de eventos que se activa cuando se actualiza un documento en Firestore.
onDocumentUpdated(opts, controlador) Controlador de eventos que se activa cuando se actualiza un documento en Firestore.
onDocumentWritten(documento, controlador) Controlador de eventos que se activa cuando se crea, actualiza o elimina un documento en Firestore.
onDocumentWritten(opts, controlador) Controlador de eventos que se activa cuando se crea, actualiza o elimina un documento en Firestore.

Clases

Clase Descripción
Cambiar La interfaz de Cloud Functions para eventos que cambian de estado, como los eventos Realtime Database o Cloud Firestore onWrite y onUpdate . Para obtener más información sobre el formato utilizado para construir objetos Change , consulte a continuación.

Interfaces

Interfaz Descripción
Opciones de documento DocumentOptions amplía EventHandlerOptions con el documento proporcionado y la base de datos y el espacio de nombres opcionales.
FirestoreEvento Un CloudEvent que contiene una instantánea de documento o un cambio

Tipo de alias

Tipo Alias Descripción
Instantánea del documento Una instantánea del documento de Firestore
ConsultaDocumentoInstantánea Una consulta de FirestoreDocumentSnapshot

firestore.onDocumentCreated()

Controlador de eventos que se activa cuando se crea un documento en Firestore.

Firma:

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

Parámetros

Parámetro Tipo Descripción
documento Documento La ruta del documento de Firestore para activar.
manipulador (evento: FirestoreEvent < QueryDocumentSnapshot | indefinido, parámetros de <Documento>>) => cualquiera | Promesa <cualquiera> Controlador de eventos que se ejecuta cada vez que se crea una Firestore.

Devoluciones:

Función de nube < Evento de tienda de fuego < QueryDocumentSnapshot | indefinido, parámetros de <Documento>>>

firestore.onDocumentCreated()

Controlador de eventos que se activa cuando se crea un documento en Firestore.

Firma:

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

Parámetros

Parámetro Tipo Descripción
opta Opciones de documento <Documento> Opciones que se pueden configurar en una función de manejo de eventos individual.
manipulador (evento: FirestoreEvent < QueryDocumentSnapshot | indefinido, parámetros de <Documento>>) => cualquiera | Promesa <cualquiera> Controlador de eventos que se ejecuta cada vez que se crea una Firestore.

Devoluciones:

Función de nube < Evento de tienda de fuego < QueryDocumentSnapshot | indefinido, parámetros de <Documento>>>

firestore.onDocumentDeleted()

Controlador de eventos que se activa cuando se elimina un documento en Firestore.

Firma:

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

Parámetros

Parámetro Tipo Descripción
documento Documento La ruta del documento de Firestore para activar.
manipulador (evento: FirestoreEvent < QueryDocumentSnapshot | indefinido, parámetros de <Documento>>) => cualquiera | Promesa <cualquiera> Controlador de eventos que se ejecuta cada vez que se produce una eliminación de Firestore.

Devoluciones:

Función de nube < Evento de tienda de fuego < QueryDocumentSnapshot | indefinido, parámetros de <Documento>>>

firestore.onDocumentDeleted()

Controlador de eventos que se activa cuando se elimina un documento en Firestore.

Firma:

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

Parámetros

Parámetro Tipo Descripción
opta Opciones de documento <Documento> Opciones que se pueden configurar en una función de manejo de eventos individual.
manipulador (evento: FirestoreEvent < QueryDocumentSnapshot | indefinido, parámetros de <Documento>>) => cualquiera | Promesa <cualquiera> Controlador de eventos que se ejecuta cada vez que se produce una eliminación de Firestore.

Devoluciones:

Función de nube < Evento de tienda de fuego < QueryDocumentSnapshot | indefinido, parámetros de <Documento>>>

firestore.onDocumentUpdated()

Controlador de eventos que se activa cuando se actualiza un documento en Firestore.

Firma:

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

Parámetros

Parámetro Tipo Descripción
documento Documento La ruta del documento de Firestore para activar.
manipulador (evento: FirestoreEvent < Cambiar < ConsultaDocumentoInstantánea > | indefinido, parámetros de <Documento>>) => cualquiera | Promesa <cualquiera> Controlador de eventos que se ejecuta cada vez que se produce una actualización de Firestore.

Devoluciones:

Función de nube < Evento de tienda de fuego < Cambiar < ConsultaDocumentoInstantánea > | indefinido, parámetros de <Documento>>>

firestore.onDocumentUpdated()

Controlador de eventos que se activa cuando se actualiza un documento en Firestore.

Firma:

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

Parámetros

Parámetro Tipo Descripción
opta Opciones de documento <Documento> Opciones que se pueden configurar en una función de manejo de eventos individual.
manipulador (evento: FirestoreEvent < Cambiar < ConsultaDocumentoInstantánea > | indefinido, parámetros de <Documento>>) => cualquiera | Promesa <cualquiera> Controlador de eventos que se ejecuta cada vez que se produce una actualización de Firestore.

Devoluciones:

Función de nube < Evento de tienda de fuego < Cambiar < ConsultaDocumentoInstantánea > | indefinido, parámetros de <Documento>>>

firestore.onDocumentWritten()

Controlador de eventos que se activa cuando se crea, actualiza o elimina un documento en Firestore.

Firma:

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

Parámetros

Parámetro Tipo Descripción
documento Documento La ruta del documento de Firestore para activar.
manipulador (evento: FirestoreEvent < Cambiar < DocumentoInstantánea > | indefinido, parámetros de <Documento>>) => cualquiera | Promesa <cualquiera> Controlador de eventos que se ejecuta cada vez que se crea, actualiza o elimina una Firestore.

Devoluciones:

Función de nube < Evento de tienda de fuego < Cambiar < DocumentoInstantánea > | indefinido, parámetros de <Documento>>>

firestore.onDocumentWritten()

Controlador de eventos que se activa cuando se crea, actualiza o elimina un documento en Firestore.

Firma:

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

Parámetros

Parámetro Tipo Descripción
opta Opciones de documento <Documento> Opciones que se pueden configurar en una función de manejo de eventos individual.
manipulador (evento: FirestoreEvent < Cambiar < DocumentoInstantánea > | indefinido, parámetros de <Documento>>) => cualquiera | Promesa <cualquiera> Controlador de eventos que se ejecuta cada vez que se crea, actualiza o elimina una Firestore.

Devoluciones:

Función de nube < Evento de tienda de fuego < Cambiar < DocumentoInstantánea > | indefinido, parámetros de <Documento>>>

firestore.DocumentSnapshot

Una instantánea del documento de Firestore

Firma:

export type DocumentSnapshot = firestore.DocumentSnapshot;

firestore.QueryDocumentSnapshot

Una consulta de FirestoreDocumentSnapshot

Firma:

export type QueryDocumentSnapshot = firestore.QueryDocumentSnapshot;