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 opciones predeterminadas para todas las funciones escritas con el SDK de segunda generación. |
Clases
| Clase | Descripción |
|---|---|
| Cambiar | La interfaz de Cloud Functions para eventos que cambian de estado, como los eventos Realtime Database o Cloud Firestore onWrite y onUpdate . 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. |
| Función de nube | (BETA) Un controlador para CloudEvents. |
| Opciones de controlador de eventos | Campos adicionales que se pueden configurar en cualquier función de manejo de eventos. |
| Opciones globales | GlobalOptions son opciones que se pueden configurar en todo un proyecto. Estas opciones son comunes a HTTPS y a las funciones de manejo de eventos. |
Espacios de nombres
| Espacio de nombres | Descripción |
|---|---|
| alertas | |
| base de datos | |
| eventarco | |
| tienda de fuego | |
| https | |
| identidad | |
| registrador | |
| parámetros | |
| pubsub | |
| configuración remota | |
| planificador | |
| almacenamiento | |
| tareas | |
| laboratorio de pruebas |
Tipo de alias
| Tipo Alias | 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. |
| parámetros de | Un tipo que asigna todos los grupos de captura de parámetros a las claves de un registro. Por ejemplo, parámetros de < "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 |
| Región admitida | Lista de todas las regiones compatibles con Cloud Functions (segunda generación). |
| Configuración de salida de Vpc | Lista de opciones disponibles para VpcConnectorEgressSettings . |
establecerOpcionesGlobal()
Establece opciones predeterminadas para todas las funciones escritas con el SDK de segunda generación.
Firma:
export declare function setGlobalOptions(options: GlobalOptions): void;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| opciones | Opciones globales | Opciones para establecer como predeterminado |
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";
parámetros de
Un tipo que asigna todos los grupos de captura de parámetros a las claves de un registro. Por ejemplo, parámetros de < "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
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 (segunda 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";