firebase-functions package

Funciones

Función Descripción
configuración() Almacene y recupere datos de configuración del proyecto, como claves API de terceros u otras configuraciones. Puede establecer valores de configuración mediante Firebase CLI como se describe en [Configuración del entorno](/docs/functions/config-env).
opciones al punto final (opciones)
opcionesParaTrigger(opciones)
región(regiones) Configure las regiones en las que se implementa la función.
ejecutar con (opciones de tiempo de ejecución) Configure las opciones de tiempo de ejecución para la funció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.
Generador de funciones

Interfaces

Interfaz Descripción
Función de bloqueo El tipo de función para los activadores del bloqueo de autenticación.
Función de nube El tipo de función para todos los activadores que no son HTTPS. Esto debe exportarse desde su archivo JavaScript para definir una función en la nube. Este tipo es una función especial de JavaScript que toma un objeto Event con plantilla como único argumento.
Opciones de implementación Opciones de configuración para una función que se aplica durante la implementación de la función.
Evento Formato de cable para un evento.
Contexto del evento El contexto en el que ocurrió un evento.
Política de fallas Opción de configuración para política de fallas en funciones en segundo plano.
Función Https El tipo de función para los desencadenadores HTTPS. Esto debe exportarse desde su archivo JavaScript para definir una función en la nube.
Recurso El recurso es un formato estándar para definir un recurso (google.rpc.context.AttributeContext.Resource). En Cloud Functions, es el recurso que activó la función, como un depósito de almacenamiento.
Ejecutable Un Runnable tiene un método run que invoca directamente la función definida por el usuario, lo que resulta útil para pruebas unitarias.
Opciones de tiempo de ejecución Opciones de configuración para una función aplicable en tiempo de ejecución.
Cronograma Opciones de configuración de funciones programadas.
ProgramarRetryConfig Opciones de reintento del programador. Aplica sólo para funciones programadas.

Espacios de nombres

Espacio de nombres Descripción
analítica
autenticación
base de datos
tienda de fuego
https
registrador
parámetros
pubsub
configuración remota
almacenamiento
tareas
laboratorio de pruebas

variables

Variable Descripción
aplicación
DEFAULT_FAILURE_POLICY
INGRESS_SETTINGS_OPTIONS Lista de opciones disponibles para IngressSettings.
MAX_NUMBER_USER_LABELS
MAX_TIMEOUT_SECONDS Valor de tiempo de espera máximo de Cloud Functions.
MIN_TIMEOUT_SECONDS Valor mínimo de tiempo de espera de Cloud Functions.
RESET_VALUE Valor de configuración especial para restablecer la configuración a los valores predeterminados de la plataforma.
SUPPORTED_REGIONS Lista de todas las regiones compatibles con Cloud Functions.
VALID_MEMORY_OPTIONS Lista de opciones de memoria disponibles compatibles con Cloud Functions.
VPC_EGRESS_SETTINGS_OPTIONS Lista de opciones disponibles para VpcConnectorEgressSettings.

configuración()

Almacene y recupere datos de configuración del proyecto, como claves API de terceros u otras configuraciones. Puede establecer valores de configuración mediante Firebase CLI como se describe en [Configuración del entorno](/docs/functions/config-env).

Firma:

export declare function config(): Record<string, any>;

Devoluciones:

Grabar<cadena, cualquiera>

opciones al punto final()

Firma:

export declare function optionsToEndpoint(options: DeploymentOptions): ManifestEndpoint;

Parámetros

Parámetro Tipo Descripción
opciones Opciones de implementación

Devoluciones:

Punto final manifiesto

opcionesToTrigger()

Firma:

export declare function optionsToTrigger(options: DeploymentOptions): any;

Parámetros

Parámetro Tipo Descripción
opciones Opciones de implementación

Devoluciones:

cualquier

región()

Configure las regiones en las que se implementa la función.

Firma:

export declare function region(...regions: Array<(typeof SUPPORTED_REGIONS)[number] | string | Expression<string> | ResetValue>): FunctionBuilder;

Parámetros

Parámetro Tipo Descripción
regiones Matriz<(tipo de SUPPORTED_REGIONS )[número] | cadena | Expresión <cadena> | Restablecer valor> Una de más cadenas de región.

Devoluciones:

Generador de funciones

Ejemplo 1

funciones.region('us-east1')

Ejemplo 2

funciones.region('nosotros-este1', 'nosotros-central1')

corre con()

Configure las opciones de tiempo de ejecución para la función.

Firma:

export declare function runWith(runtimeOptions: RuntimeOptions): FunctionBuilder;

Parámetros

Parámetro Tipo Descripción
Opciones de tiempo de ejecución Opciones de tiempo de ejecución Objeto con campos opcionales: 1. memory : cantidad de memoria para asignar a la función, los valores posibles son: '128 MB', '256 MB', '512 MB', '1 GB', '2 GB', '4 GB' y '8 GB' . 2. timeoutSeconds : tiempo de espera para la función en segundos, los valores posibles son de 0 a 540. 3. failurePolicy : política de falla de la función, siendo el valor booleano true equivalente a proporcionar un objeto de reintento vacío. 4. vpcConnector : identificación de un conector VPC en el mismo proyecto y región. 5. vpcConnectorEgressSettings : cuando se configura un vpcConnector, controla qué tráfico de salida se envía a través del vpcConnector. 6. serviceAccount : Cuenta de servicio específica para la función. 7. ingressSettings : configuración de ingreso para la función, que controla desde dónde se puede llamar a una función HTTPS. El valor no debe ser nulo.

Devoluciones:

Generador de funciones

aplicación

Firma:

app: {
    setEmulatedAdminApp: typeof setEmulatedAdminApp;
}

DEFAULT_FAILURE_POLICY

Firma:

DEFAULT_FAILURE_POLICY: FailurePolicy

INGRESS_SETTINGS_OPTIONS

Lista de opciones disponibles para IngressSettings.

Firma:

INGRESS_SETTINGS_OPTIONS: readonly ["INGRESS_SETTINGS_UNSPECIFIED", "ALLOW_ALL", "ALLOW_INTERNAL_ONLY", "ALLOW_INTERNAL_AND_GCLB"]

MAX_NUMBER_USER_LABELS

Firma:

MAX_NUMBER_USER_LABELS = 58

MAX_TIMEOUT_SECONDS

Valor de tiempo de espera máximo de Cloud Functions.

Firma:

MAX_TIMEOUT_SECONDS = 540

MIN_TIMEOUT_SECONDS

Valor mínimo de tiempo de espera de Cloud Functions.

Firma:

MIN_TIMEOUT_SECONDS = 0

RESET_VALUE

Valor de configuración especial para restablecer la configuración a los valores predeterminados de la plataforma.

Firma:

RESET_VALUE: ResetValue

SUPPORTED_REGIONS

Lista de todas las regiones compatibles con Cloud Functions.

Firma:

SUPPORTED_REGIONS: readonly ["us-central1", "us-east1", "us-east4", "us-west2", "us-west3", "us-west4", "europe-central2", "europe-west1", "europe-west2", "europe-west3", "europe-west6", "asia-east1", "asia-east2", "asia-northeast1", "asia-northeast2", "asia-northeast3", "asia-south1", "asia-southeast1", "asia-southeast2", "northamerica-northeast1", "southamerica-east1", "australia-southeast1"]

VALID_MEMORY_OPTIONS

Lista de opciones de memoria disponibles compatibles con Cloud Functions.

Firma:

VALID_MEMORY_OPTIONS: readonly ["128MB", "256MB", "512MB", "1GB", "2GB", "4GB", "8GB"]

VPC_EGRESS_SETTINGS_OPTIONS

Lista de opciones disponibles para VpcConnectorEgressSettings.

Firma:

VPC_EGRESS_SETTINGS_OPTIONS: readonly ["VPC_CONNECTOR_EGRESS_SETTINGS_UNSPECIFIED", "PRIVATE_RANGES_ONLY", "ALL_TRAFFIC"]