https namespace

Funções

Função Descrição
onCall(opts, handle) Declara um método chamável para os clientes chamarem usando um SDK do Firebase.
onCall(handler) Declara um método chamável para os clientes chamarem usando um SDK do Firebase.
onRequest(opts, handle) Processa solicitações HTTPS.
onRequest(handler) Processa solicitações HTTPS.

Classes

Turma Descrição
HttpsError (em inglês) Um erro explícito que pode ser gerado a partir de um manipulador para enviar um erro ao cliente que chamou a função.

Interfaces

Interface Descrição
CallableFunction (link em inglês) Cria um método chamável para os clientes chamarem usando um SDK do Firebase.
CallableOptions (em inglês) Opções que podem ser definidas em uma função HTTPS chamável.
CallableRequest (em inglês) A solicitação usada para chamar uma função chamável.
HttpsOptions (em inglês) Opções que podem ser definidas em uma função HTTPS onRequest.
Solicitação Uma solicitação expressa com a representação de formato eletrônico do corpo da solicitação.

Aliases de tipos

Alias de tipo Descrição
FunctionsErrorCode (em inglês) O conjunto de códigos de status do Firebase Functions. Os códigos são os mesmos expostos por gRPC.
HttpsFunction (link em inglês) Processa solicitações HTTPS.

https.onCall()

Declara um método chamável para os clientes chamarem usando um SDK do Firebase.

Assinatura:

export declare function onCall<T = any, Return = any | Promise<any>>(opts: CallableOptions, handler: (request: CallableRequest<T>) => Return): CallableFunction<T, Return>;

Parâmetros

Parâmetro Tipo Descrição
opta CallableOptions (em inglês) Opções a serem definidas nessa função.
handler (solicitação: CallableRequest<T>) => Devolver Uma função que usa um https.CallableRequest.

Retorna:

CallableFunction<T, Return>

Uma função que pode ser exportada e implantada.

https.onCall()

Declara um método chamável para os clientes chamarem usando um SDK do Firebase.

Assinatura:

export declare function onCall<T = any, Return = any | Promise<any>>(handler: (request: CallableRequest<T>) => Return): CallableFunction<T, Return>;

Parâmetros

Parâmetro Tipo Descrição
handler (solicitação: CallableRequest<T>) => Devolver Uma função que usa um https.CallableRequest.

Retorna:

CallableFunction<T, Return>

Uma função que pode ser exportada e implantada.

https.onRequest().

Processa solicitações HTTPS.

Assinatura:

export declare function onRequest(opts: HttpsOptions, handler: (request: Request, response: express.Response) => void | Promise<void>): HttpsFunction;

Parâmetros

Parâmetro Tipo Descrição
opta HttpsOptions (em inglês) Opções a serem definidas nesta função
handler (solicitação: Request, resposta: express.Response) => anular | Promessa<void> Uma função que usa um https.Request e um objeto de resposta, a mesma assinatura de um app Express.

Retorna:

HttpsFunction (link em inglês)

Uma função que pode ser exportada e implantada.

https.onRequest().

Processa solicitações HTTPS.

Assinatura:

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

Parâmetros

Parâmetro Tipo Descrição
handler (solicitação: Request, resposta: express.Response) => anular | Promessa<void> Uma função que usa um https.Request e um objeto de resposta, a mesma assinatura de um app Express.

Retorna:

HttpsFunction (link em inglês)

Uma função que pode ser exportada e implantada.

https.FunctionsErrorCode

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

Valores possíveis:

  • cancelled: a operação foi cancelada, normalmente pelo autor da chamada.

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

  • invalid-argument: o cliente especificou um argumento inválido. Ele é diferente de failed-precondition. invalid-argument indica argumentos 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 fosse 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 sucesso. Por exemplo, uma resposta bem-sucedida de um servidor pode ter atrasado tempo suficiente para que o prazo expirasse.

  • not-found: alguns documentos solicitados não foram encontrados.

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

  • permission-denied: o autor da chamada 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 estado do sistema não é o necessário para a execução da operação.

  • aborted: a operação foi cancelada, normalmente devido a um problema de simultaneidade, como cancelamentos de transações etc.

  • out-of-range: houve uma tentativa de operação após o intervalo válido.

  • unimplemented: a operação não foi implementada ou não tem suporte/não está ativada.

  • internal: erros internos. Significa que algumas invariantes esperadas pelo sistema subjacente foram corrompidas. Se você encontrar um desses erros, significa que há algo muito errado.

  • unavailable: o serviço não está disponível no momento. Provavelmente, essa é uma condição temporária e poderá ser corrigida ao tentar novamente com uma espera.

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

  • unauthenticated: a solicitação não tem 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";

https.HttpsFunction

Processa solicitações HTTPS.

Assinatura:

export type HttpsFunction = ((
req: Request, 
res: express.Response) => void | Promise<void>) & {
    __trigger?: unknown;
    __endpoint: ManifestEndpoint;
};