firebase-admin.functions package

servicio de Firebase Functions.

Funciones

Función Descripción
getFunctions(app) Obtiene el servicio de Funciones para la app predeterminada o una app determinada.Se puede llamar a getFunctions() sin argumentos para acceder al servicio Functions de la app predeterminada o como getFunctions(app) para acceder al servicio Functions asociado con una app específica.

Clases

Clase Descripción
Funciones La interfaz de servicio Functions de Firebase.
Lista de tareas en cola La interfaz de TaskQueue

Interfaces

Interfaz Descripción
Backend Delivery Interfaz que representa opciones de tareas con entrega absoluta.
DelayDelivery Interfaz que representa opciones de tareas con entrega retrasada.
TaskOptionsExperimental Tipo que representa opciones de tareas experimentales (beta).

Escribe alias

Alias de tipo Descripción
DeliverySchedule Es un tipo que representa las opciones de programación de la entrega. DeliverySchedule es un tipo de unión de los tipos DelayDelivery y absoluteDelivery.
TaskOptions Tipo que representa opciones de tareas.

getFunctions(app)

Obtiene el servicio Functions para la app predeterminada o una app determinada.

Se puede llamar a getFunctions() sin argumentos para acceder al servicio Functions de la app predeterminada o como getFunctions(app) para acceder al servicio Functions asociado con una app específica.

Firma:

export declare function getFunctions(app?: App): Functions;

Parámetros

Parámetro Tipo Descripción
app App App opcional para la que se muestra el servicio Functions Si no se proporciona, se muestra el servicio Functions predeterminado.

Devuelve:

Funciones

El servicio predeterminado Functions si no se proporciona ninguna app, o bien el servicio Functions asociado con la app proporcionada.

Ejemplo 1

// Get the `Functions` service for the default app
const defaultFunctions = getFunctions();

Ejemplo 2

// Get the `Functions` service for a given app
const otherFunctions = getFunctions(otherApp);

Programación de entrega

Es un tipo que representa las opciones de programación de la entrega. DeliverySchedule es un tipo de unión de los tipos DelayDelivery y absoluteDelivery.

Firma:

export type DeliverySchedule = DelayDelivery | AbsoluteDelivery;

TaskOptions

Tipo que representa opciones de tareas.

Firma:

export type TaskOptions = DeliverySchedule & TaskOptionsExperimental & {
    dispatchDeadlineSeconds?: number;
    id?: string;
    headers?: Record<string, string>;
};