functions package

Cloud Functions para Firebase

Funções

Função Descrição
function(app, ...) (link em inglês)
getFunctions(app, regionOrCustomDomain) Retorna uma instância de Functions para o app especificado.
function(functionsInstance, ...)
connectFunctionsEmulator(functionsInstance, host, porta) Modifique esta instância para se comunicar com o emulador do Cloud Functions.Observação: isso precisa ser chamado antes que a instância seja usada para fazer qualquer operação.
httpsCallable(functionsInstance, name, options) Retorna uma referência ao acionador HTTPS chamável com o nome fornecido.
httpsCallableFromURL(functionsInstance, url, options) Retorna uma referência ao acionador HTTPS chamável com o URL especificado.

Interfaces

Interface Descrição
Funções Uma instância Functions.
FunctionsError (link em inglês) Um erro retornado pelo SDK do cliente do Firebase Functions.
HttpsCallableOptions (em inglês) Uma interface para metadados sobre como as chamadas precisam ser executadas.
HttpsCallableResult (link em inglês) Um HttpsCallableResult encapsula um único resultado de uma chamada de funçã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 pelo gRPC aqui: https://github.com/grpc/grpc/blob/master/doc/statuscodes.mdValores possíveis: - 'cancelled': a operação foi cancelada, normalmente pelo autor da chamada. - "Desconhecido": erro desconhecido ou um erro de um domínio de erro diferente. - "invalid-argument": o cliente especificou um argumento inválido. Observe que isso é diferente de "precondição com falha". "argumento inválido" indica argumentos 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 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": algum documento solicitado não foi encontrado. - "já-existe": algum 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 sistema não está no estado necessário para a execução dela. - 'aborted': a operação foi cancelada, normalmente devido a um problema de simultaneidade, como cancelamentos de transações etc. - 'out-of-range': a operação foi tentada depois do intervalo válido. - "não implementado": a operação não foi implementada ou não é compatível/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. - "indisponível": 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.
FunctionsErrorCodeCore (em inglês) String do código de erro do Functions anexada depois de "functions/" prefixo do produto. Consulte FunctionsErrorCode para ver a documentação completa dos códigos.
HttpsCallable (em inglês) Uma referência a um elemento "chamável" Gatilho HTTP no Google Cloud Functions.

função(app, ...)

getFunctions(app, regionOrCustomDomain)

Retorna uma instância de Functions para o app especificado.

Assinatura:

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

Parâmetros

Parâmetro Tipo Descrição
app FirebaseApp O FirebaseApp a ser usado.
regiãoouDomíniopersonalizado string uma das seguintes: a) A região onde as funções chamáveis estão localizadas (por exemplo: us-central1) b) Um domínio personalizado que hospeda as funções chamáveis (por exemplo: https://meudominio.com)

Retorna:

Funções

function(functionsInstance, ...)

connectFunctionsEmulator(functionsInstance, 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

Parâmetro Tipo Descrição
FunctionsInstance Funções
host string O host do emulador (por exemplo: localhost)
porta number A porta do emulador (por exemplo: 5001)

Retorna:

void

httpsCallable(functionsInstance, name, options)

Retorna uma referência ao acionador HTTPS chamável com o nome fornecido.

Assinatura:

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

Parâmetros

Parâmetro Tipo Descrição
FunctionsInstance Funções
nome string O nome do acionador.
options HttpsCallableOptions (em inglês)

Retorna:

HttpsCallable<RequestData, ResponseData>

httpsCallableFromURL(functionsInstance, url, options)

Retorna uma referência ao acionador HTTPS chamável com o URL especificado.

Assinatura:

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

Parâmetros

Parâmetro Tipo Descrição
FunctionsInstance Funções
url string O URL do acionador.
options HttpsCallableOptions (em inglês)

Retorna:

HttpsCallable<RequestData, ResponseData>

FunctionsErrorCode

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 autor da chamada). - "Desconhecido": erro desconhecido ou um erro de um domínio de erro diferente. - "invalid-argument": o cliente especificou um argumento inválido. Observe que isso é diferente de "precondição com falha". "argumento inválido" indica argumentos 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 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": algum documento solicitado não foi encontrado. - "já-existe": algum 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 sistema não está no estado necessário para a execução dela. - 'aborted': a operação foi cancelada, normalmente devido a um problema de simultaneidade, como cancelamentos de transações etc. - 'out-of-range': a operação foi tentada depois do intervalo válido. - "não implementado": a operação não foi implementada ou não é compatível/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. - "indisponível": 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 declare type FunctionsErrorCode = `functions/${FunctionsErrorCodeCore}`;

FunctionsErrorCodeCore

String do código de erro do Functions anexada depois de "functions/" prefixo do produto. Consulte FunctionsErrorCode para ver a 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 elemento "chamável" Gatilho HTTP no Google Cloud Functions.

Assinatura:

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