firebase-admin.functions package

Servicio de funciones de Firebase.

Funciones

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

Clases

Clase	Descripción
Funciones	La interfaz del servicio Firebase Functions .
Cola de tareas	La interfaz TaskQueue .

Interfaces

Interfaz	Descripción
Entrega Absoluta	Interfaz que representa opciones de tareas con entrega absoluta.
Entrega atrasada	Interfaz que representa opciones de tareas con entrega retrasada.
Opciones de tareaExperimental	Tipo que representa opciones de tareas experimentales (beta).

Tipo de alias

Tipo Alias	Descripción
Calendario de entregas	Tipo que representa las opciones de programación de entrega. DeliverySchedule es un tipo de unión de los tipos DelayDelivery y AbsoluteDelivery .
Opciones de tarea	Tipo que representa las opciones de la tarea.

obtener funciones()

Obtiene el servicio Functions para la aplicación predeterminada o una aplicación determinada.

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

Firma:

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

Parámetros

Parámetro	Tipo	Descripción
aplicación	Aplicación	App opcional para devolver el servicio Functions . Si no se proporciona, se devuelve el servicio Functions predeterminado.

Devoluciones:

Funciones

El servicio Functions predeterminado si no se proporciona ninguna aplicación, o el servicio Functions asociado con la aplicación 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);

Calendario de entregas

Tipo que representa las opciones de programación de entrega. DeliverySchedule es un tipo de unión de los tipos DelayDelivery y AbsoluteDelivery .

Firma:

export type DeliverySchedule = DelayDelivery | AbsoluteDelivery;

Opciones de tarea

Tipo que representa las opciones de la tarea.

Firma:

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