https namespace

Funções

Função	Descrição
onCall(manipulador)	Declara um método que pode ser chamado pelos clientes usando um SDK do Firebase.
onRequest(manipulador)	Lidar com solicitações HTTP.

Aulas

Aula	Descrição
Erro HTTPS	Um erro explícito que pode ser gerado por um manipulador para enviar um erro ao cliente que chamou a função.

Interfaces

Interface	Descrição
CallableContext	A interface para metadados da API transmitida ao manipulador.
Solicitar	Uma solicitação expressa com a representação em formato de ligação do corpo da solicitação.

Aliases de tipo

Digite Alias	Descrição
FunçõesErrorCode	O conjunto de códigos de status do Firebase Functions. Os códigos são os mesmos expostos pelo gRPC .

https.onCall()

Declara um método que pode ser chamado pelos clientes usando um SDK do Firebase.

Assinatura:

export declare function onCall(handler: (data: any, context: CallableContext) => any | Promise<any>): HttpsFunction & Runnable<any>;

Parâmetros

Parâmetro	Tipo	Descrição
manipulador	(dados: qualquer, contexto: CallableContext ) => qualquer | Promessa<qualquer>	Um método que pega dados e contexto e retorna um valor.

Retorna:

HttpsFunção e executável <qualquer>

https.onRequest()

Lidar com solicitações HTTP.

Assinatura:

export declare function onRequest(handler: (req: Request, resp: express.Response) => void | Promise<void>): HttpsFunction;

Parâmetros

Parâmetro	Tipo	Descrição
manipulador	(req: Solicitação, resp: express.Response) => void | Promessa<void>	Uma função que recebe um objeto de solicitação e resposta, a mesma assinatura de um aplicativo Express.

Retorna:

Função HTTPS

https.FunctionsErrorCode

O conjunto de códigos de status do Firebase Functions. Os códigos são os mesmos expostos pelo gRPC .

Valores possíveis:

• cancelled : a operação foi cancelada (normalmente pelo chamador).

• unknown : Erro desconhecido ou um erro de um domínio de erro diferente.

• invalid-argument : o cliente especificou um argumento inválido. Observe que isso difere da failed-precondition . invalid-argument indica argumentos que são problemáticos, independentemente do estado do sistema (por exemplo, um nome de campo inválido).

• deadline-exceeded : O prazo expirou antes que a operação pudesse ser concluída. Para operações que alteram o estado do sistema, este erro pode ser retornado mesmo que a operação tenha sido concluída com êxito. Por exemplo, uma resposta bem-sucedida de um servidor poderia ter sido atrasada o suficiente para que o prazo expirasse.

• not-found : Algum documento solicitado não foi encontrado.

• already-exists : Algum documento que tentamos criar já existe.

• permission-denied : o chamador não tem permissão para executar a operação especificada.

• resource-exhausted : algum recurso foi esgotado, talvez uma cota por usuário ou talvez todo o sistema de arquivos esteja sem espaço.

• failed-precondition : A operação foi rejeitada porque o sistema não está no estado necessário para a execução da operação.

• aborted : a operação foi abortada, normalmente devido a um problema de simultaneidade, como abortamentos de transação, etc.

• out-of-range : A operação foi tentada além do intervalo válido.

• unimplemented : a operação não está implementada ou não é suportada/habilitada.

• internal : Erros internos. Significa que alguns invariantes esperados pelo sistema subjacente foram quebrados. Se você vir um desses erros, algo está muito quebrado.

• unavailable : o serviço não está disponível no momento. Esta é provavelmente uma condição transitória e pode ser corrigida tentando novamente com uma espera.

• data-loss : Perda ou corrupção irrecuperável de dados.

• unauthenticated : a solicitação não possui credenciais de autenticação válidas para a operação.

Assinatura:

export type FunctionsErrorCode = "ok" | "cancelled" | "unknown" | "invalid-argument" | "deadline-exceeded" | "not-found" | "already-exists" | "permission-denied" | "resource-exhausted" | "failed-precondition" | "aborted" | "out-of-range" | "unimplemented" | "internal" | "unavailable" | "data-loss" | "unauthenticated";