firebase-admin.functions package

Service de fonctions Firebase.

Les fonctions

Fonction Description
getFunctions (application) Obtient le service Functions pour l’application par défaut ou une application donnée. getFunctions() peut être appelé sans argument pour accéder au service Functions de l'application par défaut ou en tant que getFunctions(app) pour accéder au service Functions associé à une application spécifique.

Des classes

Classe Description
Les fonctions L'interface du service Firebase Functions .
File d'attente des tâches L'interface TaskQueue .

Interfaces

Interface Description
Livraison absolue Interface représentant les options de tâches avec livraison absolue.
Retard de livraison Interface représentant les options de tâches avec livraison différée.
TaskOptionsExpérimental Type représentant les options de tâches expérimentales (bêta).

Tapez les alias

Tapez l'alias Description
Calendrier de livraison Type représentant les options de calendrier de livraison. DeliverySchedule est un type d’union des types DelayDelivery et AbsoluteDelivery .
Options de tâches Type représentant les options de tâche.

obtenirFonctions()

Obtient le service Functions pour l’application par défaut ou une application donnée.

getFunctions() peut être appelé sans argument pour accéder au service Functions de l'application par défaut ou en tant que getFunctions(app) pour accéder au service Functions associé à une application spécifique.

Signature:

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

Paramètres

Paramètre Taper Description
application Application Application facultative pour laquelle renvoyer le service Functions . S’il n’est pas fourni, le service Functions par défaut est renvoyé.

Retour:

Les fonctions

Le service Functions par défaut si aucune application n'est fournie, ou le service Functions associé à l'application fournie.

Exemple 1

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

Exemple 2

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

Calendrier de livraison

Type représentant les options de calendrier de livraison. DeliverySchedule est un type d’union des types DelayDelivery et AbsoluteDelivery .

Signature:

export type DeliverySchedule = DelayDelivery | AbsoluteDelivery;

Options de tâches

Type représentant les options de tâche.

Signature:

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