firebase-functions package

La API de segunda generación para Cloud Functions para Firebase. Este SDK admite importaciones profundas. 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(opciones) Establece las opciones predeterminadas para todas las funciones escritas con el SDK de 2.ª generación.

Clases

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

Interfaces

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

Espacios de nombres

espacio de nombres Descripción
alertas
base de datos
eventoarco
tienda de fuego
https
identidad
registrador
parámetros
pub-sub
configuración remota
programador
almacenamiento
tareas
laboratorio de pruebas

Tipo de alias

Alias ​​de tipo Descripción
Configuración de ingreso Lista de opciones disponibles para IngressSettings .
Opción de memoria Lista de opciones de memoria disponibles compatibles con Cloud Functions.
ParamsOf Un tipo que mapea todos los grupos de captura de parámetros en claves de un registro. Por ejemplo, ParamsOf < "usuarios/ { fluido } " > es {uid: cadena} ParamsOf < "usuarios/ { fluido } /registros/ { registro } " > es {uid: cadena; registro: cadena } ParamsOf < "algunos/estáticos/datos" > es { } Por razones de flexibilidad, ParamsOf es registro < cuerda, cuerda >
SupportedRegion Lista de todas las regiones compatibles con Cloud Functions (2.ª generación).
Configuración de salida de Vpc Lista de opciones disponibles para VpcConnectorEgressSettings .

establecerOpcionesGlobales()

Establece las opciones predeterminadas para todas las funciones escritas con el SDK de 2.ª generación.

Firma:

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

Parámetros

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

Devoluciones:

vacío

Configuración de ingreso

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

ParamsOf

Un tipo que mapea todos los grupos de captura de parámetros en claves de un registro. Por ejemplo, ParamsOf < "usuarios/ { fluido } " > es {uid: cadena} ParamsOf < "usuarios/ { fluido } /registros/ { registro } " > es {uid: cadena; registro: cadena } ParamsOf < "algunos/estáticos/datos" > es { }

Por razones de flexibilidad, ParamsOf es registro < cuerda, cuerda >

Firma:

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

SupportedRegion

Lista de todas las regiones compatibles con Cloud Functions (2.ª generación).

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 salida de Vpc

Lista de opciones disponibles para VpcConnectorEgressSettings .

Firma:

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