https namespace

Funções

Função Descrição
onCall(manipulador) Declara um método chamável para os clientes chamarem usando um Firebase SDK.
onRequest(manipulador) Lidar com solicitações HTTP.

Aulas

Aula Descrição
HttpsErro Um erro explícito que pode ser lançado de um manipulador para enviar um erro ao cliente que chamou a função.

Interfaces

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

Aliases de tipo

Digite Alias Descrição
FunctionsErrorCode 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 chamável para os clientes chamarem usando um Firebase SDK.

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 | Prometa <qualquer> Um método que recebe dados e contexto e retorna um valor.

Retorna:

HttpsFunction & Runnable <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: Pedido, 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, esse erro pode ser retornado mesmo se a operação for concluída com êxito. Por exemplo, uma resposta bem-sucedida de um servidor pode ter sido atrasada o suficiente para que o prazo expire.

  • 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á em um estado necessário para a execução da operação.

  • aborted : a operação foi abortada, normalmente devido a um problema de simultaneidade, como cancelamentos 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 algumas invariantes esperadas pelo sistema subjacente foram quebradas. 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 com uma nova tentativa com uma retirada.

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

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