Firebase is back at Google I/O on May 14! Register now.

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

firestore namespace

Funciones

Función	Descripción
onDocumentCreated(documento, manejador)	Controlador de eventos que se activa cuando se crea un documento en Firestore.
onDocumentCreated(opciones, 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(opciones, 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(opciones, controlador)	Controlador de eventos que se activa cuando se actualiza un documento en Firestore.
onDocumentWritten(documento, manejador)	Controlador de eventos que se activa cuando se crea, actualiza o elimina un documento en Firestore.
onDocumentWritten(opciones, 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 Realtime Database o eventos `onWrite` y `onUpdate` de Cloud Firestore. 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 DocumentSnapshot o un Change

Tipo de alias

Alias de tipo	Descripción
Instantánea del documento	Una instantánea de un 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 desencadenar.
manipulador	(evento: FirestoreEvent < Instantánea de documento de consulta \| indefinido, ParamsOf <Documento>>) => cualquiera \| Promesa <cualquiera>	Controlador de eventos que se ejecuta cada vez que se crea un Firestore.

Devoluciones:

CloudFunction < Evento Firestore < Instantánea de documento de consulta | indefinido, 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
opta	Opciones de documento <Documento>	Opciones que se pueden configurar en una función de gestión de eventos individual.
manipulador	(evento: FirestoreEvent < Instantánea de documento de consulta \| indefinido, ParamsOf <Documento>>) => cualquiera \| Promesa <cualquiera>	Controlador de eventos que se ejecuta cada vez que se crea un Firestore.

Devoluciones:

CloudFunction < Evento Firestore < Instantánea de documento de consulta | indefinido, ParamsOf <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 desencadenar.
manipulador	(evento: FirestoreEvent < Instantánea de documento de consulta \| indefinido, ParamsOf <Documento>>) => cualquiera \| Promesa <cualquiera>	Controlador de eventos que se ejecuta cada vez que se elimina Firestore.

Devoluciones:

CloudFunction < Evento Firestore < Instantánea de documento de consulta | indefinido, ParamsOf <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 gestión de eventos individual.
manipulador	(evento: FirestoreEvent < Instantánea de documento de consulta \| indefinido, ParamsOf <Documento>>) => cualquiera \| Promesa <cualquiera>	Controlador de eventos que se ejecuta cada vez que se elimina Firestore.

Devoluciones:

CloudFunction < Evento Firestore < Instantánea de documento de consulta | indefinido, 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 del documento de Firestore para desencadenar.
manipulador	(evento: FirestoreEvent < Cambiar < ConsultaDocumentoInstantánea > \| indefinido, ParamsOf <Documento>>) => cualquiera \| Promesa <cualquiera>	Controlador de eventos que se ejecuta cada vez que se produce una actualización de Firestore.

Devoluciones:

CloudFunction < Evento Firestore < Cambiar < ConsultaDocumentoInstantánea > | indefinido, 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>(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 gestión de eventos individual.
manipulador	(evento: FirestoreEvent < Cambiar < ConsultaDocumentoInstantánea > \| indefinido, ParamsOf <Documento>>) => cualquiera \| Promesa <cualquiera>	Controlador de eventos que se ejecuta cada vez que se produce una actualización de Firestore.

Devoluciones:

CloudFunction < Evento Firestore < Cambiar < ConsultaDocumentoInstantánea > | indefinido, ParamsOf <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 desencadenar.
manipulador	(evento: FirestoreEvent < Cambiar < Instantánea del documento > \| indefinido, ParamsOf <Documento>>) => cualquiera \| Promesa <cualquiera>	Controlador de eventos que se ejecuta cada vez que se crea, actualiza o elimina un Firestore.

Devoluciones:

CloudFunction < Evento Firestore < Cambiar < Instantánea del documento > | indefinido, ParamsOf <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 gestión de eventos individual.
manipulador	(evento: FirestoreEvent < Cambiar < Instantánea del documento > \| indefinido, ParamsOf <Documento>>) => cualquiera \| Promesa <cualquiera>	Controlador de eventos que se ejecuta cada vez que se crea, actualiza o elimina un Firestore.

Devoluciones:

CloudFunction < Evento Firestore < Cambiar < Instantánea del documento > | indefinido, ParamsOf <Documento>>>

firestore.DocumentSnapshot

Una instantánea de un documento de Firestore

Firma:

export type DocumentSnapshot = firestore.DocumentSnapshot;

firestore.QueryDocumentSnapshot

Una consulta de FirestoreDocumentSnapshot

Firma:

export type QueryDocumentSnapshot = firestore.QueryDocumentSnapshot;