firebase-functions package

Funções

Função Descrição
config(); Armazene e recupere dados de configuração do projeto, como chaves de API de terceiros e outras configurações. É possível definir valores de configuração usando a CLI do Firebase, conforme descrito em [Configuração do ambiente](/docs/functions/config-env).
optionsToEndpoint(options)
optionsToTrigger(options)
region(regions) Configure as regiões em que a função é implantada.
runWith(runtimeOptions) (em inglês) Configurar opções de ambiente de execução para a função.

Classes

Turma Descrição
Alterar Interface do Cloud Functions para eventos que mudam de estado, como os eventos onWrite e onUpdate do Realtime Database ou Cloud Firestore.Confira abaixo mais informações sobre o formato usado para construir objetos Change.
FunctionBuilder (link em inglês)

Interfaces

Interface Descrição
BlockingFunction O tipo de função para acionadores de bloqueio de autenticação.
CloudFunction O tipo de função para todos os gatilhos não HTTPS. Ele precisa ser exportado do seu arquivo JavaScript para definir uma função do Cloud.Esse tipo é uma função JavaScript especial que usa um objeto Event de modelo como único argumento.
DeploymentOptions (em inglês) Opções de configuração para uma função que se aplica durante a implantação da função.
Evento Formato de transferência para um evento.
EventContext (link em inglês) O contexto em que um evento ocorreu.
FailurePolicy (link em inglês) Opção de configuração da política de falha em funções em segundo plano.
HttpsFunction (link em inglês) O tipo de função para acionadores de HTTPS. Ela precisa ser exportada do seu arquivo JavaScript para definir uma função do Cloud.
Recurso O 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 executável tem um método run que invoca diretamente a função definida pelo usuário, o que é útil para testes de unidade.
RuntimeOptions (em inglês) Opções de configuração para uma função aplicáveis no momento da execução.
Programar Opções de configuração para funções programadas.
ProgramRetryConfig (em inglês) Opções de nova tentativa do programador. Aplica-se apenas a funções programadas.

Namespaces

Namespace Descrição
análise
autenticação
database
firestore
https
logger (em inglês)
parâmetros
pubsub
remoteConfig (em inglês)
armazenamento
tarefas
testLab (link em inglês)

Variáveis

Variável Descrição
app
DEFAULT_FAILED_POLICY (em inglês)
INGRESS_CONFIG_OPTIONS (em inglês) Lista de opções disponíveis para IngressSettings.
MAX_NUMBER_USER_LABELS
MAX_TIMEOUT_SECONDS Valor de tempo limite máximo do Cloud Functions.
MIN_TIMEOUT_SECONDS Valor de tempo limite mínimo do Cloud Functions.
REDEFINIR_VALOR Valor de configuração especial para redefinir a configuração para o padrão da plataforma.
SUPORTE_REGIÕES Lista de todas as regiões compatíveis com o Cloud Functions.
VALID_MEMORY_OPTIONS (em inglês) Lista de opções de memória disponíveis compatíveis com o Cloud Functions.
VPC_EGRESS_CONFIG_OPTIONS Lista de opções disponíveis para VpcConnectorEgressSettings.

config().

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

Assinatura:

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

Retorna:

Record<string, any>

optionsToEndpoint()

Assinatura:

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

Parâmetros

Parâmetro Tipo Descrição
options DeploymentOptions (em inglês)

Retorna:

EndpointEndpoint

optionsToTrigger().

Assinatura:

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

Parâmetros

Parâmetro Tipo Descrição
options DeploymentOptions (em inglês)

Retorna:

qualquer um

region()

Configure as regiões em que a função é 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)[number] | string | Expressão<string> | RedefinirValue> Uma ou mais strings de região.

Retorna:

FunctionBuilder (link em inglês)

Exemplo 1

functions.region('us-east1')

Exemplo 2

functions.region('us-east1', 'us-central1')

runWith()

Configurar opções de ambiente de execução para a função.

Assinatura:

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

Parâmetros

Parâmetro Tipo Descrição
ambiente de execução RuntimeOptions (em inglês) Objeto com campos opcionais: 1. memory: quantidade de memória a ser alocada para a função. Os valores possíveis são "128 MB", "256 MB", "512 MB", "1 GB", "2 GB", "4 GB" e "8 GB". 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, com o booleano true sendo equivalente a fornecer um objeto de repetição vazio. 4. vpcConnector: ID de um conector de VPC no mesmo projeto e região. 5. vpcConnectorEgressSettings: quando um vpcConnector estiver configurado, controle qual tráfego de saída é enviado pelo vpcConnector. 6. serviceAccount: conta de serviço específica para a função. 7. ingressSettings: configurações de entrada da função, que controlam de onde uma função HTTPS pode ser chamada.O valor não pode ser nulo.

Retorna:

FunctionBuilder (link em inglês)

app

Assinatura:

app: {
    setEmulatedAdminApp: typeof setEmulatedAdminApp;
}

POLÍTICA_DE_FALHA_PADRÃO

Assinatura:

DEFAULT_FAILURE_POLICY: FailurePolicy

INGRESS_CONFIG_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 de tempo limite máximo do Cloud Functions.

Assinatura:

MAX_TIMEOUT_SECONDS = 540

MIN_TIMEOUT_SECONDS

Valor de tempo limite mínimo do Cloud Functions.

Assinatura:

MIN_TIMEOUT_SECONDS = 0

REDEFINIR_VALOR

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

Assinatura:

RESET_VALUE: ResetValue

REGIÕES COMPATÍVEIS

Lista de todas as regiões compatíveis com o 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 o Cloud Functions.

Assinatura:

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

VPC_EGRESS_CONFIG_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"]