firestore namespace

Funções

Função	Descrição
onDocumentCreated(documento, gerenciador)	Manipulador de eventos que é acionado quando um documento é criado no Firestore.
onDocumentCreated(opts, handle)	Manipulador de eventos que é acionado quando um documento é criado no Firestore.
onDocumentExcluído(documento, gerenciador)	Manipulador de eventos que é acionado quando um documento é excluído no Firestore.
onDocumentExcluído(opts, handle)	Manipulador de eventos que é acionado quando um documento é excluído no Firestore.
onDocumentUpdated(documento, gerenciador)	Manipulador de eventos que é acionado quando um documento é atualizado no Firestore.
onDocumentUpdated(opts, handle)	Manipulador de eventos que é acionado quando um documento é atualizado no Firestore.
onDocumentWriter(document, gerenciador)	Manipulador de eventos que é acionado quando um documento é criado, atualizado ou excluído no Firestore.
onDocumentWriter(opts, handle)	Manipulador de eventos que é acionado quando um documento é criado, atualizado ou excluído no Firestore.

Classes

Turma	Descrição
Alterar	Interface do Cloud Functions para eventos que mudam de estado, como os eventos onWrite e onUpdate do Realtime Database ou Cloud Firestore.Confira abaixo mais informações sobre o formato usado para construir objetos Change.

Interfaces

Interface	Descrição
DocumentOptions (em inglês)	DocumentOptions estendem EventHandlerOptions com o documento fornecido, o banco de dados e o namespace opcionais.
FirestoreEvent	Um CloudEvent que contém um DocumentSnapshot ou uma Change

Aliases de tipos

Alias de tipo	Descrição
DocumentSnapshot (em inglês)	Um DocumentSnapshot do Firestore
QueryDocumentSnapshot (em inglês)	Um QueryDocumentSnapshot do Firestore

firestore.onDocumentCreated().

Manipulador de eventos que é acionado quando um documento é criado no Firestore.

Assinatura:

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	Descrição
documento	Documento	O caminho do documento do Firestore para acionar.
handler	(evento: FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>) => qualquer | Promessa<qualquer>	Manipulador de eventos que é executado sempre que ocorre uma criação do Firestore.

Retorna:

CloudFunction<FirestoreEvent<QueryDocumentSnapshot | indefinido, ParamsOf<Document>>>

firestore.onDocumentCreated().

Manipulador de eventos que é acionado quando um documento é criado no Firestore.

Assinatura:

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	Descrição
opta	DocumentOptions<Document>	Opções que podem ser definidas em uma função de manipulação de eventos individual.
handler	(evento: FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>) => qualquer | Promessa<qualquer>	Manipulador de eventos que é executado sempre que ocorre uma criação do Firestore.

Retorna:

CloudFunction<FirestoreEvent<QueryDocumentSnapshot | indefinido, ParamsOf<Document>>>

firestore.onDocumentExcluído()

Manipulador de eventos que é acionado quando um documento é excluído no Firestore.

Assinatura:

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	Descrição
documento	Documento	O caminho do documento do Firestore para acionar.
handler	(evento: FirestoreEvent<QueryDocumentSnapshot | indefinido, ParamsOf<Document>>) => qualquer | Promessa<qualquer>	Manipulador de eventos que é executado sempre que ocorre uma exclusão do Firestore.

Retorna:

CloudFunction<FirestoreEvent<QueryDocumentSnapshot | indefinido, ParamsOf<Document>>>

firestore.onDocumentExcluído()

Manipulador de eventos que é acionado quando um documento é excluído no Firestore.

Assinatura:

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	Descrição
opta	DocumentOptions<Document>	Opções que podem ser definidas em uma função de manipulação de eventos individual.
handler	(evento: FirestoreEvent<QueryDocumentSnapshot | indefinido, ParamsOf<Document>>) => qualquer | Promessa<qualquer>	Manipulador de eventos que é executado sempre que ocorre uma exclusão do Firestore.

Retorna:

CloudFunction<FirestoreEvent<QueryDocumentSnapshot | indefinido, ParamsOf<Document>>>

firestore.onDocumentUpdated()

Manipulador de eventos que é acionado quando um documento é atualizado no Firestore.

Assinatura:

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	Descrição
documento	Documento	O caminho do documento do Firestore para acionar.
handler	(evento: FirestoreEvent<Alterar<QueryDocumentSnapshot> | undefined, ParamsOf<Document>>) => qualquer | Promessa<qualquer>	Manipulador de eventos que é executado sempre que ocorre uma atualização do Firestore.

Retorna:

CloudFunction<FirestoreEvent<Alterar<QueryDocumentSnapshot> | indefinido, ParamsOf<Document>>>

firestore.onDocumentUpdated()

Manipulador de eventos que é acionado quando um documento é atualizado no Firestore.

Assinatura:

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	Descrição
opta	DocumentOptions<Document>	Opções que podem ser definidas em uma função de manipulação de eventos individual.
handler	(evento: FirestoreEvent<Alterar<QueryDocumentSnapshot> | undefined, ParamsOf<Document>>) => qualquer | Promessa<qualquer>	Manipulador de eventos que é executado sempre que ocorre uma atualização do Firestore.

Retorna:

CloudFunction<FirestoreEvent<Alterar<QueryDocumentSnapshot> | indefinido, ParamsOf<Document>>>

firestore.onDocumentWriter()

Manipulador de eventos que é acionado quando um documento é criado, atualizado ou excluído no Firestore.

Assinatura:

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	Descrição
documento	Documento	O caminho do documento do Firestore para acionar.
handler	(evento: FirestoreEvent<Alterar<DocumentSnapshot> | indefinido, ParamsOf<Document>>) => qualquer | Promessa<qualquer>	Manipulador de eventos que é executado sempre que ocorre uma criação, atualização ou exclusão do Firestore.

Retorna:

CloudFunction<FirestoreEvent<Alterar<DocumentSnapshot> | indefinido, ParamsOf<Document>>>

firestore.onDocumentWriter()

Manipulador de eventos que é acionado quando um documento é criado, atualizado ou excluído no Firestore.

Assinatura:

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	Descrição
opta	DocumentOptions<Document>	Opções que podem ser definidas em uma função de manipulação de eventos individual.
handler	(evento: FirestoreEvent<Alterar<DocumentSnapshot> | indefinido, ParamsOf<Document>>) => qualquer | Promessa<qualquer>	Manipulador de eventos que é executado sempre que ocorre uma criação, atualização ou exclusão do Firestore.

Retorna:

CloudFunction<FirestoreEvent<Alterar<DocumentSnapshot> | indefinido, ParamsOf<Document>>>

firestore.DocumentSnapshot

Um DocumentSnapshot do Firestore

Assinatura:

export type DocumentSnapshot = firestore.DocumentSnapshot;

firestore.QueryDocumentSnapshot

Um QueryDocumentSnapshot do Firestore

Assinatura:

export type QueryDocumentSnapshot = firestore.QueryDocumentSnapshot;