https namespace

Funções

Aulas

Interfaces

Aliases de tipo

https.onCall()

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

Assinatura:

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

Parâmetros

Retorna:

CallableFunction<T, Return>

Uma função que você pode exportar e implantar.

https.onCall()

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

Assinatura:

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

Parâmetros

Retorna:

CallableFunction<T, Return>

Uma função que você pode exportar e implantar.

https.onRequest()

Lida com solicitações HTTPS.

Assinatura:

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

Parâmetros

Retorna:

Função Https

Uma função que você pode exportar e implantar.

https.onRequest()

Lida com solicitações HTTPS.

Assinatura:

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

Parâmetros

Retorna:

Função Https

Uma função que você pode exportar e implantar.

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

https.HttpsFunction

Lida com solicitações HTTPS.

Assinatura:

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