functions package

Funções de nuvem para Firebase

Funções

Interfaces

Aliases de tipo

função (aplicativo, ...)

getFunctions(app, regiãoOrCustomDomain)

Retorna uma instância do Functions para o aplicativo determinado.

Assinatura:

export declare function getFunctions(app?: FirebaseApp, regionOrCustomDomain?: string): Functions;

Parâmetros

Retorna:

Funções

função(funçõesInstância, ...)

connectFunctionsEmulator(funçõesInstance, host, porta)

Modifique esta instância para se comunicar com o emulador do Cloud Functions.

Assinatura:

export declare function connectFunctionsEmulator(functionsInstance: Functions, host: string, port: number): void;

Parâmetros

Retorna:

vazio

httpsCallable(funçõesInstance, nome, opções)

Retorna uma referência ao gatilho HTTPS que pode ser chamado com o nome fornecido.

Assinatura:

export declare function httpsCallable<RequestData = unknown, ResponseData = unknown>(functionsInstance: Functions, name: string, options?: HttpsCallableOptions): HttpsCallable<RequestData, ResponseData>;

Parâmetros

Retorna:

HttpsCallable <RequestData, ResponseData>

httpsCallableFromURL(funçõesInstance, url, opções)

Retorna uma referência ao gatilho HTTPS que pode ser chamado com o URL especificado.

Assinatura:

export declare function httpsCallableFromURL<RequestData = unknown, ResponseData = unknown>(functionsInstance: Functions, url: string, options?: HttpsCallableOptions): HttpsCallable<RequestData, ResponseData>;

Parâmetros

Retorna:

HttpsCallable <RequestData, ResponseData>

FunçõesErrorCode

O conjunto de códigos de status do Firebase Functions. Os códigos são os mesmos expostos pelo gRPC aqui: https://github.com/grpc/grpc/blob/master/doc/statuscodes.md

Valores possíveis: - 'cancelled': A operação foi cancelada (normalmente pelo chamador). - 'desconhecido': Erro desconhecido ou erro de um domínio de erro diferente. - 'argumento inválido': o cliente especificou um argumento inválido. Observe que isso difere de 'pré-condição com falha'. 'argumento inválido' indica argumentos que são problemáticos independentemente do estado do sistema (por exemplo, um nome de campo inválido). - 'prazo excedido': 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. - 'não encontrado': Algum documento solicitado não foi encontrado. - 'já existe': Algum documento que tentamos criar já existe. - 'permission-denied': O chamador não tem permissão para executar a operação especificada. - 'recurso esgotado': 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. - 'abortado': A operação foi abortada, normalmente devido a um problema de simultaneidade, como abortos de transação, etc. - 'fora do intervalo': A operação foi tentada além do intervalo válido. - 'não implementado': a operação não está implementada ou não é suportada/habilitada. - 'interno': Erros internos. Significa que alguns invariantes esperados pelo sistema subjacente foram quebrados. Se você vir um desses erros, algo está muito quebrado. - 'indisponível': 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. - 'perda de dados': 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 declare type FunctionsErrorCode = `functions/${FunctionsErrorCodeCore}`;

FunçõesErrorCodeCore

Sequência de código de erro de funções anexada após o prefixo do produto "funções/". Consulte FunctionsErrorCode para documentação completa dos códigos.

Assinatura:

export declare type FunctionsErrorCodeCore = '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';

HttpsCallable

Uma referência a um gatilho HTTP "chamável" no Google Cloud Functions.

Assinatura:

export declare type HttpsCallable<RequestData = unknown, ResponseData = unknown> = (data?: RequestData | null) => Promise<HttpsCallableResult<ResponseData>>;