firebase-functions package

La API de 2a gen. de Cloud Functions para Firebase. Este SDK admite importaciones directas. Por ejemplo, el espacio de nombres pubsub está disponible en firebase-functions/v2 o se puede importar directamente desde firebase-functions/v2/pubsub.

Funciones

Función Descripción
setGlobalOptions(options) Establece las opciones predeterminadas para todas las funciones escritas con el SDK de 2a gen.

Clases

Clase Descripción
Cambiar La interfaz de Cloud Functions para eventos que cambian de estado, como los eventos onWrite y onUpdate de Realtime Database o Cloud Firestore.Para obtener más información sobre el formato que se usa para construir objetos Change, consulta a continuación.

Interfaces

Interfaz Descripción
CloudEvent (BETA) Un CloudEventBase es la base de un formato multiplataforma para codificar un evento sin servidores. Para obtener más información, consulta https://github.com/cloudevents/spec.
CloudFunction (BETA) Un controlador para CloudEvents.
EventHandlerOptions Campos adicionales que se pueden configurar en cualquier función de control de eventos.
Opciones globales GlobalOptions son opciones que se pueden establecer en todo un proyecto. Estas opciones son comunes a HTTPS y a las funciones de control de eventos.

Espacios de nombres

Espacio de nombres Descripción
alertas
base de datos
eventarc
Firestore
https
identidad
registrador
parámetros
pubsub
remoteConfig
programador
almacenamiento
tareas
testLab

Escribe alias

Alias de tipo Descripción
IngressSetting Lista de opciones disponibles para IngressSettings.
MemoryOption Lista de opciones de memoria disponibles compatibles con Cloud Functions.
ParamsOf Es un tipo que asigna todos los grupos de captura de parámetros a claves de un registro. Por ejemplo, ParamsOf<"users/{uid}"> es { uid: string } ParamsOf<"users/{uid}/logs/{log}"> is { uid: string; log: string } ParamsOf<"algo/estático/datos"> es {}Por motivos de flexibilidad, ParamsOf es Record<string, string>
CompatibleRegión Lista de todas las regiones compatibles con Cloud Functions (2nd gen).
VpcEgressSetting Lista de opciones disponibles para VpcConnectorEgressSettings.

setGlobalOptions()

Establece las opciones predeterminadas para todas las funciones escritas con el SDK de 2a gen.

Firma:

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

Parámetros

Parámetro Tipo Descripción
opciones Opciones globales Opciones para establecer como predeterminada

Muestra:

void

IngressSetting

Lista de opciones disponibles para IngressSettings.

Firma:

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

Opción de memoria

Lista de opciones de memoria disponibles compatibles con Cloud Functions.

Firma:

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

Parámetros de

Es un tipo que asigna todos los grupos de captura de parámetros a claves de un registro. Por ejemplo, ParamsOf<"users/{uid}"> es { uid: string } ParamsOf<"users/{uid}/logs/{log}"> is { uid: string; log: string } ParamsOf<"algo/estático/datos"> es {}

Por motivos de flexibilidad, ParamsOf es Record<string, string>

Firma:

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

Región Admitida

Lista de todas las regiones compatibles con Cloud Functions (2nd gen).

Firma:

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";

Configuración de VpcEgress

Lista de opciones disponibles para VpcConnectorEgressSettings.

Firma:

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