Se usó la API de Cloud Translation para traducir esta página.

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 borra un documento en Firestore.
onDocumentDeleted(opts, controlador)	Controlador de eventos que se activa cuando se borra un documento en Firestore.
onDocumentUpdated(documento, controlador)	Controlador de eventos que se activa cuando se actualiza un documento en Firestore.
onDocumentUpdated(opts, driver)	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 borra un documento en Firestore.
onDocumentWritten(opts, controlador)	Controlador de eventos que se activa cuando se crea, actualiza o borra un documento en Firestore.

Clases

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

Interfaces

Interfaz	Descripción
Opciones de documentos	DocumentOptions extiende EventHandlerOptions con el documento proporcionado y la base de datos y el espacio de nombres opcionales.
FirestoreEvent	Un CloudEvent que contiene una DocumentSnapshot o un Change

Escribe alias

Alias de tipo	Descripción
DocumentSnapshot	Una DocumentSnapshot de Firestore
QueryDocumentSnapshot	Una QueryDocumentSnapshot de Firestore

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 de acceso del documento de Firestore para activar.
handler	(evento: FirestoreEvent<QueryDocumentSnapshot \| undefined, ParamsOf<Document>>) => cualquier \| Promesa<cualquiera>	Controlador de eventos que se ejecuta cada vez que se crea un Firestore.

Muestra:

CloudFunction<FirestoreEvent<QueryDocumentSnapshot | no definido, ParamsOf<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
opciones	DocumentOptions<Documento>	Opciones que se pueden configurar en una función de control de eventos individual.
handler	(evento: FirestoreEvent<QueryDocumentSnapshot \| undefined, ParamsOf<Document>>) => cualquier \| Promesa<cualquiera>	Controlador de eventos que se ejecuta cada vez que se crea un Firestore.

Muestra:

CloudFunction<FirestoreEvent<QueryDocumentSnapshot | no definido, ParamsOf<Documento>>>

firestore.onDocumentDeleted()

Controlador de eventos que se activa cuando se borra 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 de acceso del documento de Firestore para activar.
handler	(evento: FirestoreEvent<QueryDocumentSnapshot \| undefined, ParamsOf<Document>>) => cualquier \| Promesa<cualquiera>	Controlador de eventos que se ejecuta cada vez que se borra una operación de Firestore.

Muestra:

CloudFunction<FirestoreEvent<QueryDocumentSnapshot | no definido, ParamsOf<Documento>>>

firestore.onDocumentDeleted()

Controlador de eventos que se activa cuando se borra 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
opciones	DocumentOptions<Documento>	Opciones que se pueden configurar en una función de control de eventos individual.
handler	(evento: FirestoreEvent<QueryDocumentSnapshot \| undefined, ParamsOf<Document>>) => cualquier \| Promesa<cualquiera>	Controlador de eventos que se ejecuta cada vez que se borra una operación de Firestore.

Muestra:

CloudFunction<FirestoreEvent<QueryDocumentSnapshot | no definido, ParamsOf<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 de acceso del documento de Firestore para activar.
handler	(evento: FirestoreEvent<Cambiar<QueryDocumentSnapshot> \| sin definir, ParamsOf<Document>>) => cualquier \| Promesa<cualquiera>	Controlador de eventos que se ejecuta cada vez que se produce una actualización de Firestore.

Muestra:

CloudFunction<FirestoreEvent<Cambiar<QueryDocumentSnapshot> | no definido, ParamsOf<Document>>>

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
opciones	DocumentOptions<Documento>	Opciones que se pueden configurar en una función de control de eventos individual.
handler	(evento: FirestoreEvent<Cambiar<QueryDocumentSnapshot> \| sin definir, ParamsOf<Document>>) => cualquier \| Promesa<cualquiera>	Controlador de eventos que se ejecuta cada vez que se produce una actualización de Firestore.

Muestra:

CloudFunction<FirestoreEvent<Cambiar<QueryDocumentSnapshot> | no definido, ParamsOf<Document>>>

firestore.onDocumentWritten()

Controlador de eventos que se activa cuando se crea, actualiza o borra 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 de acceso del documento de Firestore para activar.
handler	(evento: FirestoreEvent<Cambiar<DocumentSnapshot> \| sin definir, ParamsOf<Document>>) => cualquier \| Promesa<cualquiera>	Controlador de eventos que se ejecuta cada vez que se crea, actualiza o borra una instancia de Firestore.

Muestra:

CloudFunction<FirestoreEvent<Cambio<DocumentSnapshot> | no definido, ParamsOf<Document>>>

firestore.onDocumentWritten()

Controlador de eventos que se activa cuando se crea, actualiza o borra 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
opciones	DocumentOptions<Documento>	Opciones que se pueden configurar en una función de control de eventos individual.
handler	(evento: FirestoreEvent<Cambiar<DocumentSnapshot> \| sin definir, ParamsOf<Document>>) => cualquier \| Promesa<cualquiera>	Controlador de eventos que se ejecuta cada vez que se crea, actualiza o borra una instancia de Firestore.

Muestra:

CloudFunction<FirestoreEvent<Cambio<DocumentSnapshot> | no definido, ParamsOf<Document>>>

firestore.DocumentSnapshot

Una DocumentSnapshot de Firestore

Firma:

export type DocumentSnapshot = firestore.DocumentSnapshot;

firestore.QueryDocumentSnapshot

Una QueryDocumentSnapshot de Firestore

Firma:

export type QueryDocumentSnapshot = firestore.QueryDocumentSnapshot;