functions package

Cloud-Funktionen für Firebase

Funktionen

Funktion Beschreibung
Funktion(App, ...)
getFunctions(app, regionOrCustomDomain) Gibt eine Functions- Instanz für die angegebene App zurück.
Funktion(FunktionenInstanz, ...)
connectFunctionsEmulator(functionsInstance, host, port) Ändern Sie diese Instanz, um mit dem Cloud Functions-Emulator zu kommunizieren. Hinweis: Dies muss aufgerufen werden, bevor diese Instanz zum Ausführen von Vorgängen verwendet wurde.
httpsCallable(functionsInstance, name, options) Gibt einen Verweis auf den aufrufbaren HTTPS-Trigger mit dem angegebenen Namen zurück.
httpsCallableFromURL(functionsInstance, url, options) Gibt einen Verweis auf den aufrufbaren HTTPS-Trigger mit der angegebenen URL zurück.

Schnittstellen

Schnittstelle Beschreibung
Funktionen Eine Functions Instanz.
Funktionsfehler Ein vom Firebase Functions-Client-SDK zurückgegebener Fehler.
HttpsCallableOptions Eine Schnittstelle für Metadaten darüber, wie Aufrufe ausgeführt werden sollen.
HttpsCallableResult Ein HttpsCallableResult umschließt ein einzelnes Ergebnis eines Funktionsaufrufs.

Geben Sie Aliase ein

Geben Sie Alias ​​ein Beschreibung
FunctionsErrorCode Der Satz von Firebase Functions-Statuscodes. Die Codes sind die gleichen wie die von gRPC hier bereitgestellten: https://github.com/grpc/grpc/blob/master/doc/statuscodes.md Mögliche Werte: - 'abgebrochen': Der Vorgang wurde abgebrochen (normalerweise durch den Aufrufer). - „unbekannt“: Unbekannter Fehler oder ein Fehler aus einer anderen Fehlerdomäne. - 'invalid-argument': Der Client hat ein ungültiges Argument angegeben. Beachten Sie, dass sich dies von „failed-precondition“ unterscheidet. „ungültiges Argument“ weist auf Argumente hin, die unabhängig vom Zustand des Systems problematisch sind (z. B. ein ungültiger Feldname). - 'deadline-exceeded': Die Frist ist abgelaufen, bevor der Vorgang abgeschlossen werden konnte. Bei Vorgängen, die den Zustand des Systems ändern, kann dieser Fehler auch dann zurückgegeben werden, wenn der Vorgang erfolgreich abgeschlossen wurde. Beispielsweise könnte sich eine erfolgreiche Antwort eines Servers so lange verzögert haben, dass die Frist abgelaufen ist. - 'not-found': Ein angefordertes Dokument wurde nicht gefunden. - „already-exists“: Ein Dokument, das wir erstellen wollten, existiert bereits. – „Berechtigung verweigert“: Der Aufrufer hat keine Berechtigung, den angegebenen Vorgang auszuführen. - „Ressource erschöpft“: Eine Ressource ist erschöpft, möglicherweise ist ein Kontingent pro Benutzer erreicht, oder möglicherweise ist im gesamten Dateisystem nicht mehr genügend Speicherplatz vorhanden. - „failed-precondition“: Der Vorgang wurde abgelehnt, da sich das System nicht in einem für die Ausführung des Vorgangs erforderlichen Zustand befindet. – „abgebrochen“: Der Vorgang wurde abgebrochen, typischerweise aufgrund eines Parallelitätsproblems wie Transaktionsabbrüche usw. – „Außerhalb des gültigen Bereichs“: Der Vorgang wurde außerhalb des gültigen Bereichs versucht. - 'unimplemented': Der Vorgang ist nicht implementiert oder nicht unterstützt/aktiviert. - 'internal': Interne Fehler. Bedeutet, dass einige vom zugrunde liegenden System erwartete Invarianten beschädigt wurden. Wenn Sie einen dieser Fehler sehen, ist etwas sehr kaputt. - 'nicht verfügbar': Der Dienst ist derzeit nicht verfügbar. Dies ist höchstwahrscheinlich ein vorübergehender Zustand und kann durch einen erneuten Versuch mit einem Backoff behoben werden. - „Datenverlust“: Nicht behebbarer Datenverlust oder Datenbeschädigung. – „nicht authentifiziert“: Die Anfrage verfügt nicht über gültige Authentifizierungsdaten für den Vorgang.
FunctionsErrorCodeCore Nach dem Produktpräfix „functions/“ wird eine Zeichenfolge mit dem Fehlercode „Functions“ angehängt. Eine vollständige Dokumentation der Codes finden Sie unter FunctionsErrorCode .
HttpsCallable Ein Verweis auf einen „aufrufbaren“ HTTP-Trigger in Google Cloud Functions.

Funktion(App, ...)

getFunctions(app, regionOrCustomDomain)

Gibt eine Functions- Instanz für die angegebene App zurück.

Unterschrift:

export declare function getFunctions(app?: FirebaseApp, regionOrCustomDomain?: string): Functions;

Parameter

Parameter Typ Beschreibung
App FirebaseApp Die zu verwendende FirebaseApp .
regionOrCustomDomain Zeichenfolge eine von: a) der Region, in der sich die aufrufbaren Funktionen befinden (z. B. us-central1) b) einer benutzerdefinierten Domäne, die die aufrufbaren Funktionen hostet (z. B. https://mydomain.com)

Kehrt zurück:

Funktionen

Funktion(FunktionenInstanz, ...)

connectFunctionsEmulator(functionsInstance, host, port)

Ändern Sie diese Instanz, um mit dem Cloud Functions-Emulator zu kommunizieren.

Unterschrift:

export declare function connectFunctionsEmulator(functionsInstance: Functions, host: string, port: number): void;

Parameter

Parameter Typ Beschreibung
FunktionenInstanz Funktionen
Gastgeber Zeichenfolge Der Emulator-Host (z. B. localhost)
Hafen Nummer Der Emulator-Port (z. B. 5001)

Kehrt zurück:

Leere

httpsCallable(functionsInstance, name, options)

Gibt einen Verweis auf den aufrufbaren HTTPS-Trigger mit dem angegebenen Namen zurück.

Unterschrift:

export declare function httpsCallable<RequestData = unknown, ResponseData = unknown>(functionsInstance: Functions, name: string, options?: HttpsCallableOptions): HttpsCallable<RequestData, ResponseData>;

Parameter

Parameter Typ Beschreibung
FunktionenInstanz Funktionen
Name Zeichenfolge Der Name des Triggers.
Optionen HttpsCallableOptions

Kehrt zurück:

HttpsCallable <RequestData, ResponseData>

httpsCallableFromURL(functionsInstance, url, options)

Gibt einen Verweis auf den aufrufbaren HTTPS-Trigger mit der angegebenen URL zurück.

Unterschrift:

export declare function httpsCallableFromURL<RequestData = unknown, ResponseData = unknown>(functionsInstance: Functions, url: string, options?: HttpsCallableOptions): HttpsCallable<RequestData, ResponseData>;

Parameter

Parameter Typ Beschreibung
FunktionenInstanz Funktionen
URL Zeichenfolge Die URL des Auslösers.
Optionen HttpsCallableOptions

Kehrt zurück:

HttpsCallable <RequestData, ResponseData>

FunctionsErrorCode

Der Satz von Firebase Functions-Statuscodes. Die Codes sind die gleichen wie die von gRPC hier bereitgestellten: https://github.com/grpc/grpc/blob/master/doc/statuscodes.md

Mögliche Werte: - 'abgebrochen': Der Vorgang wurde abgebrochen (normalerweise durch den Aufrufer). - „unbekannt“: Unbekannter Fehler oder ein Fehler aus einer anderen Fehlerdomäne. - 'invalid-argument': Der Client hat ein ungültiges Argument angegeben. Beachten Sie, dass sich dies von „failed-precondition“ unterscheidet. „ungültiges Argument“ weist auf Argumente hin, die unabhängig vom Zustand des Systems problematisch sind (z. B. ein ungültiger Feldname). - 'deadline-exceeded': Die Frist ist abgelaufen, bevor der Vorgang abgeschlossen werden konnte. Bei Vorgängen, die den Zustand des Systems ändern, kann dieser Fehler auch dann zurückgegeben werden, wenn der Vorgang erfolgreich abgeschlossen wurde. Beispielsweise könnte sich eine erfolgreiche Antwort eines Servers so lange verzögert haben, dass die Frist abgelaufen ist. - 'not-found': Ein angefordertes Dokument wurde nicht gefunden. - „already-exists“: Ein Dokument, das wir erstellen wollten, existiert bereits. – „Berechtigung verweigert“: Der Aufrufer hat keine Berechtigung, den angegebenen Vorgang auszuführen. - „Ressource erschöpft“: Eine Ressource ist erschöpft, möglicherweise ist ein Kontingent pro Benutzer erreicht, oder möglicherweise ist im gesamten Dateisystem nicht mehr genügend Speicherplatz vorhanden. - „failed-precondition“: Der Vorgang wurde abgelehnt, da sich das System nicht in einem für die Ausführung des Vorgangs erforderlichen Zustand befindet. – „abgebrochen“: Der Vorgang wurde abgebrochen, typischerweise aufgrund eines Parallelitätsproblems wie Transaktionsabbrüche usw. – „Außerhalb des gültigen Bereichs“: Der Vorgang wurde außerhalb des gültigen Bereichs versucht. - 'unimplemented': Der Vorgang ist nicht implementiert oder nicht unterstützt/aktiviert. - 'internal': Interne Fehler. Bedeutet, dass einige vom zugrunde liegenden System erwartete Invarianten beschädigt wurden. Wenn Sie einen dieser Fehler sehen, ist etwas sehr kaputt. - 'nicht verfügbar': Der Dienst ist derzeit nicht verfügbar. Dies ist höchstwahrscheinlich ein vorübergehender Zustand und kann durch einen erneuten Versuch mit einem Backoff behoben werden. - „Datenverlust“: Nicht behebbarer Datenverlust oder Datenbeschädigung. – „nicht authentifiziert“: Die Anfrage verfügt nicht über gültige Authentifizierungsdaten für den Vorgang.

Unterschrift:

export declare type FunctionsErrorCode = `functions/${FunctionsErrorCodeCore}`;

FunctionsErrorCodeCore

Functions-Fehlercodezeichenfolge, die nach dem Produktpräfix „functions/“ angehängt wird. Eine vollständige Dokumentation der Codes finden Sie unter FunctionsErrorCode .

Unterschrift:

export declare type FunctionsErrorCodeCore = 'ok' | 'cancelled' | 'unknown' | 'invalid-argument' | 'deadline-exceeded' | 'not-found' | 'already-exists' | 'permission-denied' | 'resource-exhausted' | 'failed-precondition' | 'aborted' | 'out-of-range' | 'unimplemented' | 'internal' | 'unavailable' | 'data-loss' | 'unauthenticated';

HttpsCallable

Ein Verweis auf einen „aufrufbaren“ HTTP-Trigger in Google Cloud Functions.

Unterschrift:

export declare type HttpsCallable<RequestData = unknown, ResponseData = unknown> = (data?: RequestData | null) => Promise<HttpsCallableResult<ResponseData>>;