firebase-admin.functions package

Firebase Functions-Dienst.

Funktionen

Funktion Beschreibung
getFunctions(app) Ruft den Funktionsdienst für die Standard-App oder eine bestimmte App ab. getFunctions() kann ohne Argumente aufgerufen werden, um auf den Functions der Standard-App zuzugreifen, oder als getFunctions(app) um auf den Functions zuzugreifen, der einer bestimmten App zugeordnet ist.

Klassen

Klasse Beschreibung
Funktionen Die Firebase Functions Dienstschnittstelle.
TaskQueue Die TaskQueue Schnittstelle.

Schnittstellen

Schnittstelle Beschreibung
Absolute Lieferung Schnittstelle, die Aufgabenoptionen mit absoluter Lieferung darstellt.
Verspätete Lieferung Schnittstelle, die Aufgabenoptionen mit verzögerter Lieferung darstellt.
TaskOptionsExperimental Typ, der experimentelle (Beta-)Aufgabenoptionen darstellt.

Geben Sie Aliase ein

Geben Sie Alias ​​ein Beschreibung
Lieferungsplan Typ, der Lieferplanoptionen darstellt. DeliverySchedule ist ein Vereinigungstyp der Typen DelayDelivery und AbsoluteDelivery .
Aufgabenoptionen Typ, der Aufgabenoptionen darstellt.

getFunctions()

Ruft den Funktionsdienst für die Standard-App oder eine bestimmte App ab.

getFunctions() kann ohne Argumente aufgerufen werden, um auf den Functions der Standard-App zuzugreifen, oder als getFunctions(app) um auf den Functions zuzugreifen, der einer bestimmten App zugeordnet ist.

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
App App Optionale App, für die der Functions zurückgegeben werden soll. Wenn nicht angegeben, wird der Functions zurückgegeben.

Kehrt zurück:

Funktionen

Der standardmäßige Functions Dienst, wenn keine App bereitgestellt wird, oder der Functions Dienst, der der bereitgestellten App zugeordnet ist.

Beispiel 1

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

Beispiel 2

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

Lieferungsplan

Typ, der Lieferplanoptionen darstellt. DeliverySchedule ist ein Vereinigungstyp der Typen DelayDelivery und AbsoluteDelivery .

Unterschrift:

export type DeliverySchedule = DelayDelivery | AbsoluteDelivery;

Aufgabenoptionen

Typ, der Aufgabenoptionen darstellt.

Unterschrift:

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