firebase-functions package

A API de segunda geração do Cloud Functions para Firebase. Este SDK oferece suporte a importações profundas. Por exemplo, o namespace pubsub está disponível em firebase-functions/v2 ou pode ser importado diretamente de firebase-functions/v2/pubsub .

Funções

Função Descrição
setGlobalOptions(opções) Define opções padrão para todas as funções escritas usando o SDK de 2ª geraçã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.

Interfaces

Interface Descrição
Evento na nuvem (BETA) Um CloudEventBase é a base de um formato multiplataforma para codificação de um evento sem servidor. Para obter mais informações, consulte https://github.com/cloudevents/spec.
Função Cloud (BETA) Um manipulador para CloudEvents.
Opções de manipulador de eventos Campos adicionais que podem ser definidos em qualquer função de manipulação de eventos.
Opções globais GlobalOptions são opções que podem ser definidas em um projeto inteiro. Essas opções são comuns para HTTPS e funções de manipulação de eventos.

Espaços para nome

Espaço para nome Descrição
alertas
base de dados
Eventarc
firestore
https
identidade
registrador
parâmetros
pubsub
configuração remota
Agendador
armazenar
tarefas
laboratório de testes

Aliases de tipo

Digite Alias Descrição
Configuração de entrada Lista de opções disponíveis para IngressSettings .
Opção de memória Lista de opções de memória disponíveis compatíveis com Cloud Functions.
ParamsOf Um tipo que mapeia todos os grupos de captura de parâmetros em chaves de um registro. Por exemplo, ParamsOf < "Usuários/ { UID } " > é {uid: string} ParamsOf < "Usuários/ { UID } /Histórico/ { registro } " > é {uid: string; log: string} ParamsOf < "alguns/estáticos/dados" > é { } Por razões de flexibilidade, ParamsOf é recorde < corda, corda >
Região suportada Lista de todas as regiões suportadas pelo Cloud Functions (2ª geração).
Configuração VpcEgress Lista de opções disponíveis para VpcConnectorEgressSettings .

setGlobalOptions()

Define opções padrão para todas as funções escritas usando o SDK de 2ª geração.

Assinatura:

export declare function setGlobalOptions(options: GlobalOptions): void;

Parâmetros

Parâmetro Tipo Descrição
opções Opções globais Opções para definir como padrão

Retorna:

vazio

Configuração de entrada

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

Assinatura:

export type IngressSetting = "ALLOW_ALL" | "ALLOW_INTERNAL_ONLY" | "ALLOW_INTERNAL_AND_GCLB";

Opção de memória

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

Assinatura:

export type MemoryOption = "128MiB" | "256MiB" | "512MiB" | "1GiB" | "2GiB" | "4GiB" | "8GiB" | "16GiB" | "32GiB";

ParamsOf

Um tipo que mapeia todos os grupos de captura de parâmetros em chaves de um registro. Por exemplo, ParamsOf < "Usuários/ { UID } " > é {uid: string} ParamsOf < "Usuários/ { UID } /Histórico/ { registro } " > é {uid: string; log: string} ParamsOf < "alguns/estáticos/dados" > é { }

Por razões de flexibilidade, ParamsOf é recorde < corda, corda >

Assinatura:

export type ParamsOf<PathPattern extends string> = string extends PathPattern ? Record<string, string> : {
    [Key in Extract<Split<NullSafe<PathPattern>, "/">[number]>]: string;
};

Região suportada

Lista de todas as regiões suportadas pelo Cloud Functions (2ª geração).

Assinatura:

export type SupportedRegion = "asia-east1" | "asia-northeast1" | "asia-northeast2" | "europe-north1" | "europe-west1" | "europe-west4" | "us-central1" | "us-east1" | "us-east4" | "us-west1" | "asia-east2" | "asia-northeast3" | "asia-southeast1" | "asia-southeast2" | "asia-south1" | "australia-southeast1" | "europe-central2" | "europe-west2" | "europe-west3" | "europe-west6" | "northamerica-northeast1" | "southamerica-east1" | "us-west2" | "us-west3" | "us-west4";

Configuração VpcEgress

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

Assinatura:

export type VpcEgressSetting = "PRIVATE_RANGES_ONLY" | "ALL_TRAFFIC";