firebase-functions package

Funções

Função Descrição
configuração() Armazene e recupere dados de configuração do projeto, como chaves de API de terceiros ou outras configurações. Você pode definir valores de configuração usando a Firebase CLI conforme descrito em [Configuração do ambiente](/docs/functions/config-env).
opçõesToEndpoint(opções)
optionsToTrigger(opções)
região(regiões) Configure as regiões nas quais a função está implantada.
runWith(runtimeOptions) Configure opções de tempo de execução para a função.

Aulas

Aula Descrição
Mudar A interface do Cloud Functions para eventos que mudam de estado, como eventos onWrite e onUpdate do Realtime Database ou do Cloud Firestore. Para obter mais informações sobre o formato usado para construir objetos Change , veja abaixo.
Construtor de Funções

Interfaces

Interface Descrição
Função de bloqueio O tipo de função para gatilhos de bloqueio de autenticação.
Função Cloud O tipo de função para todos os gatilhos não HTTPS. Isso deve ser exportado do seu arquivo JavaScript para definir uma função do Cloud. Este tipo é uma função JavaScript especial que usa um objeto Event modelo como seu único argumento.
Opções de implantação Opções de configuração para uma função que se aplica durante a implantação da função.
Evento Formato de fio para um evento.
EventContext O contexto em que um evento ocorreu.
Política de falha Opção de configuração para política de falha em funções em segundo plano.
Função HTTPS O tipo de função para gatilhos HTTPS. Isso deve ser exportado do seu arquivo JavaScript para definir uma função do Cloud.
Recurso Recurso é um formato padrão para definir um recurso (google.rpc.context.AttributeContext.Resource). No Cloud Functions, é o recurso que acionou a função, como um bucket de armazenamento.
Executável Um Runnable possui um método run que invoca diretamente a função definida pelo usuário - útil para testes de unidade.
Opções de tempo de execução Opções de configuração para uma função aplicável em tempo de execução.
Agendar Opções de configuração para funções agendadas.
AgendarRetryConfig Opções de nova tentativa do agendador. Aplica-se apenas a funções agendadas.

Espaços para nome

Espaço para nome Descrição
análise
autenticação
base de dados
firestore
https
registrador
parâmetros
pubsub
configuração remota
armazenar
tarefas
laboratório de testes

Variáveis

Variável Descrição
aplicativo
DEFAULT_FAILURE_POLICY
INGRESS_SETTINGS_OPTIONS Lista de opções disponíveis para IngressSettings.
MAX_NUMBER_USER_LABELS
MAX_TIMEOUT_SECONDS Valor máximo de tempo limite do Cloud Functions.
MIN_TIMEOUT_SECONDS Valor mínimo de tempo limite do Cloud Functions.
RESET_VALUE Valor de configuração especial para redefinir a configuração para o padrão da plataforma.
SUPPORTED_REGIONS Lista de todas as regiões suportadas pelo Cloud Functions.
VALID_MEMORY_OPTIONS Lista de opções de memória disponíveis compatíveis com Cloud Functions.
VPC_EGRESS_SETTINGS_OPTIONS Lista de opções disponíveis para VpcConnectorEgressSettings.

configuração()

Armazene e recupere dados de configuração do projeto, como chaves de API de terceiros ou outras configurações. Você pode definir valores de configuração usando a Firebase CLI conforme descrito em [Configuração do ambiente](/docs/functions/config-env).

Assinatura:

export declare function config(): Record<string, any>;

Retorna:

Registro<string, qualquer>

opçõesToEndpoint()

Assinatura:

export declare function optionsToEndpoint(options: DeploymentOptions): ManifestEndpoint;

Parâmetros

Parâmetro Tipo Descrição
opções Opções de implantação

Retorna:

Ponto final do manifesto

opçõesToTrigger()

Assinatura:

export declare function optionsToTrigger(options: DeploymentOptions): any;

Parâmetros

Parâmetro Tipo Descrição
opções Opções de implantação

Retorna:

qualquer

região()

Configure as regiões nas quais a função está implantada.

Assinatura:

export declare function region(...regions: Array<(typeof SUPPORTED_REGIONS)[number] | string | Expression<string> | ResetValue>): FunctionBuilder;

Parâmetros

Parâmetro Tipo Descrição
regiões Matriz<(tipo de SUPPORTED_REGIONS )[número] | corda | Expressão <string> | RedefinirValor> Uma ou mais cadeias de regiões.

Retorna:

Construtor de Funções

Exemplo 1

funções.region('us-east1')

Exemplo 2

funções.region('us-east1', 'us-central1')

correr com()

Configure opções de tempo de execução para a função.

Assinatura:

export declare function runWith(runtimeOptions: RuntimeOptions): FunctionBuilder;

Parâmetros

Parâmetro Tipo Descrição
opções de tempo de execução Opções de tempo de execução Objeto com campos opcionais: 1. memory : quantidade de memória a ser alocada para a função, os valores possíveis são: '128MB', '256MB', '512MB', '1GB', '2GB', '4GB' e '8GB' . 2. timeoutSeconds : tempo limite da função em segundos, os valores possíveis são de 0 a 540. 3. failurePolicy : política de falha da função, sendo booleano true equivalente a fornecer um objeto de nova tentativa vazio. 4. vpcConnector : id de um conector VPC no mesmo projeto e região. 5. vpcConnectorEgressSettings : quando um vpcConnector é definido, controla qual tráfego de saída é enviado por meio do vpcConnector. 6. serviceAccount : conta de serviço específica para a função. 7. ingressSettings : configurações de entrada para a função, que controlam de onde uma função HTTPS pode ser chamada. O valor não deve ser nulo.

Retorna:

Construtor de Funções

aplicativo

Assinatura:

app: {
    setEmulatedAdminApp: typeof setEmulatedAdminApp;
}

DEFAULT_FAILURE_POLICY

Assinatura:

DEFAULT_FAILURE_POLICY: FailurePolicy

INGRESS_SETTINGS_OPTIONS

Lista de opções disponíveis para IngressSettings.

Assinatura:

INGRESS_SETTINGS_OPTIONS: readonly ["INGRESS_SETTINGS_UNSPECIFIED", "ALLOW_ALL", "ALLOW_INTERNAL_ONLY", "ALLOW_INTERNAL_AND_GCLB"]

MAX_NUMBER_USER_LABELS

Assinatura:

MAX_NUMBER_USER_LABELS = 58

MAX_TIMEOUT_SECONDS

Valor máximo de tempo limite do Cloud Functions.

Assinatura:

MAX_TIMEOUT_SECONDS = 540

MIN_TIMEOUT_SECONDS

Valor mínimo de tempo limite do Cloud Functions.

Assinatura:

MIN_TIMEOUT_SECONDS = 0

RESET_VALUE

Valor de configuração especial para redefinir a configuração para o padrão da plataforma.

Assinatura:

RESET_VALUE: ResetValue

SUPPORTED_REGIONS

Lista de todas as regiões suportadas pelo Cloud Functions.

Assinatura:

SUPPORTED_REGIONS: readonly ["us-central1", "us-east1", "us-east4", "us-west2", "us-west3", "us-west4", "europe-central2", "europe-west1", "europe-west2", "europe-west3", "europe-west6", "asia-east1", "asia-east2", "asia-northeast1", "asia-northeast2", "asia-northeast3", "asia-south1", "asia-southeast1", "asia-southeast2", "northamerica-northeast1", "southamerica-east1", "australia-southeast1"]

VALID_MEMORY_OPTIONS

Lista de opções de memória disponíveis compatíveis com Cloud Functions.

Assinatura:

VALID_MEMORY_OPTIONS: readonly ["128MB", "256MB", "512MB", "1GB", "2GB", "4GB", "8GB"]

VPC_EGRESS_SETTINGS_OPTIONS

Lista de opções disponíveis para VpcConnectorEgressSettings.

Assinatura:

VPC_EGRESS_SETTINGS_OPTIONS: readonly ["VPC_CONNECTOR_EGRESS_SETTINGS_UNSPECIFIED", "PRIVATE_RANGES_ONLY", "ALL_TRAFFIC"]