firebase-functions package

A API de 2a geração do Cloud Functions para Firebase. Este SDK é compatível com 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(options) (em inglês) Define opções padrão para todas as funções escritas usando o SDK de 2a geraçã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.

Interfaces

Interface Descrição
CloudEvent (BETA) Um CloudEventBase é a base de um formato de várias plataformas para codificar um evento sem servidor. Para mais informações, consulte https://github.com/cloudevents/spec.
CloudFunction (BETA) Um gerenciador para CloudEvents.
EventHandlerOptions. Campos adicionais que podem ser definidos em qualquer função de manipulação de eventos.
GlobalOptions (em inglês) 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.

Namespaces

Namespace Descrição
alertas
database
eventarc.
firestore
https
identidade
logger (em inglês)
parâmetros
pubsub
remoteConfig (em inglês)
programador
armazenamento
tarefas
testLab (link em inglês)

Aliases de tipos

Alias de tipo Descrição
IngressSetting (em inglês) Lista de opções disponíveis para IngressSettings.
MemoryOption (link em inglês) Lista de opções de memória disponíveis compatíveis com o Cloud Functions.
Parâmetros de Um tipo que mapeia todos os gropus de captura de parâmetros nas chaves de um registro. Por exemplo, ParamsOf<"users/{uid}"> é { uid: string } ParamsOf<"users/{uid}/logs/{log}"> is { uid: string; registro: string } ParâmetrosDe<"algum/estático/dados"> é {}Por motivos de flexibilidade, ParamsOf é Record<string, string>
supportedRegion (link em inglês) Lista de todas as regiões com suporte do Cloud Functions (2a geração).
VpcEgressSetting (em inglês) Lista de opções disponíveis para VpcConnectorEgressSettings.

setGlobalOptions()

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

Assinatura:

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

Parâmetros

Parâmetro Tipo Descrição
options GlobalOptions (em inglês) Opções para definir como padrão

Retorna:

void

IngressSetting

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

Assinatura:

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

MemoryOption

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

Assinatura:

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

Parâmetros de

Um tipo que mapeia todos os gropus de captura de parâmetros nas chaves de um registro. Por exemplo, ParamsOf<"users/{uid}"> é { uid: string } ParamsOf<"users/{uid}/logs/{log}"> is { uid: string; registro: string } ParâmetrosDe<"algum/estático/dados"> é {}

Por motivos de flexibilidade, ParamsOf é Record<string, string>

Assinatura:

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

Região compatível

Lista de todas as regiões com suporte do Cloud Functions (2a 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";

VpcEgressSetting

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

Assinatura:

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