Funciones
| Función | Descripción |
|---|---|
| config() | Almacena y recupera datos de configuración del proyecto, como claves de API de terceros y otros parámetros de configuración. Puedes establecer valores de configuración con Firebase CLI como se describe en [Configuración del entorno](/docs/functions/config-env). |
| optionsToEndpoint(opciones) | |
| optionsToTrigger(opciones) | |
| region(regiones) | Configurar las regiones en las que se implementa la función |
| runWith(runtimeOptions) | Configura las opciones del entorno 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 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. |
| FunctionBuilder |
Interfaces
| Interfaz | Descripción |
|---|---|
| Función de bloqueo | El tipo de función para los activadores de bloqueo de autenticación. |
| CloudFunction | El tipo de función para todos los activadores que no son HTTPS. Se debería exportar de tu archivo JavaScript para definir una Cloud Function.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 transferencia bancaria para un evento. |
| EventContext | Es el contexto en el que ocurrió un evento. |
| Política de fallas | Opción de configuración para la política de fallas en funciones en segundo plano. |
| HttpsFunction | El tipo de función para los activadores HTTPS. Se debería exportar desde tu archivo JavaScript para definir una Cloud Function. |
| 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 bucket de almacenamiento. |
| Ejecutable | Un objeto Runnable tiene un método run que invoca directamente la función definida por el usuario, lo cual es útil para la prueba de unidades. |
| Opciones del tiempo de ejecución | Opciones de configuración para una función que se aplica en el entorno de ejecución. |
| Programa | Opciones de configuración para funciones programadas. |
| ScheduleRetryConfig | Opciones de reintento del programador. Solo se aplica a las funciones programadas. |
Espacios de nombres
| Espacio de nombres | Descripción |
|---|---|
| Analytics | |
| autenticación | |
| base de datos | |
| Firestore | |
| https | |
| registrador | |
| parámetros | |
| pubsub | |
| remoteConfig | |
| almacenamiento | |
| tareas | |
| testLab |
Variables
| Variable | Descripción |
|---|---|
| app | |
| DEFAULT_FAILURE_POLICY | |
| OPCIONES DE CONFIGURACIÓN DE INGRESS | 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 | El valor de tiempo de espera mínimo de Cloud Functions. |
| RESTABLECER_VALOR | 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. |
| OPCIONES_DE_CONFIGURACIÓN_DE_EGRESS_VPC | Lista de opciones disponibles para VpcConnectorEgressSettings. |
config()
Almacena y recupera datos de configuración del proyecto, como claves de API de terceros y otros parámetros de configuración. Puedes establecer valores de configuración con Firebase CLI como se describe en [Configuración del entorno](/docs/functions/config-env).
Firma:
export declare function config(): Record<string, any>;
Muestra:
Registro<string, any>
optionsToEndpoint()
Firma:
export declare function optionsToEndpoint(options: DeploymentOptions): ManifestEndpoint;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| opciones | Opciones de implementación |
Muestra:
ManifestEndpoint
optionsToTrigger()
Firma:
export declare function optionsToTrigger(options: DeploymentOptions): any;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| opciones | Opciones de implementación |
Muestra:
cualquiera
región()
Configurar 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 | Arreglo<(tipo de SUPPORTED_REGIONS)[número] | cadena | Expresión<string> | RestablecerValor> | Una o más cadenas de región. |
Muestra:
Ejemplo 1
functions.region('us-east1')
Ejemplo 2
funciones.region('us-east1', 'us-central1')
runWith()
Configura las opciones del entorno de ejecución para la función.
Firma:
export declare function runWith(runtimeOptions: RuntimeOptions): FunctionBuilder;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| Opciones de entorno de ejecución | Opciones del tiempo de ejecución | Objeto con campos opcionales: 1. memory: La cantidad de memoria que se 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: Se agota el tiempo de espera de la función en segundos. Los valores posibles son de 0 a 540. 3. failurePolicy: Es la política de fallas de la función, con el booleano true que equivale a proporcionar un objeto de reintento vacío. 4. vpcConnector: Es el ID de un conector de VPC en el mismo proyecto y la misma región. 5. vpcConnectorEgressSettings: Cuando se configura vpcConnector, controla qué tráfico de salida se envía a través de vpcConnector. 6. serviceAccount: Es la cuenta de servicio específica para la función. 7. ingressSettings: Es la configuración de entrada de la función, que controla desde dónde se puede llamar a una función de HTTPS.El valor no debe ser nulo. |
Muestra:
app
Firma:
app: {
setEmulatedAdminApp: typeof setEmulatedAdminApp;
}
POLÍTICA_DE_FAILURE_PREDETERMINADA
Firma:
DEFAULT_FAILURE_POLICY: FailurePolicy
OPCIONES_DE_CONFIGURACIÓN_DE_INGRESOS
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
El valor de tiempo de espera mínimo de Cloud Functions.
Firma:
MIN_TIMEOUT_SECONDS = 0
RESTABLECER VALOR
Valor de configuración especial para restablecer la configuración a los valores predeterminados de la plataforma.
Firma:
RESET_VALUE: ResetValue
REGIONES_COMPATIBLES
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"]
OPCIONES_DE_MEMORIA_VÁLIDA
Lista de opciones de memoria disponibles compatibles con Cloud Functions.
Firma:
VALID_MEMORY_OPTIONS: readonly ["128MB", "256MB", "512MB", "1GB", "2GB", "4GB", "8GB"]
OPCIONES_DE_CONFIGURACIÓN_DE_EGRESS_DE_VPC
Lista de opciones disponibles para VpcConnectorEgressSettings.
Firma:
VPC_EGRESS_SETTINGS_OPTIONS: readonly ["VPC_CONNECTOR_EGRESS_SETTINGS_UNSPECIFIED", "PRIVATE_RANGES_ONLY", "ALL_TRAFFIC"]