https namespace

Funktionen

Funktion Beschreibung
onCall(Handler) Deklariert eine aufrufbare Methode, die Clients mithilfe eines Firebase SDK aufrufen können.
onRequest(handler) Behandeln Sie HTTP-Anfragen.

Klassen

Klasse Beschreibung
HttpsError Ein expliziter Fehler, der von einem Handler ausgelöst werden kann, um einen Fehler an den Client zu senden, der die Funktion aufgerufen hat.

Schnittstellen

Schnittstelle Beschreibung
CallableContext Die Schnittstelle für Metadaten für die API, wie sie an den Handler übergeben werden.
Anfrage Eine ausdrückliche Anfrage mit der Wire-Format-Darstellung des Anfragetextes.

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 bereitgestellten .

https.onCall()

Deklariert eine aufrufbare Methode, die Clients mithilfe eines Firebase SDK aufrufen können.

Unterschrift:

export declare function onCall(handler: (data: any, context: CallableContext) => any | Promise<any>): HttpsFunction & Runnable<any>;

Parameter

Parameter Typ Beschreibung
Handler (Daten: beliebig, Kontext: CallableContext ) => beliebig | Versprochen<any> Eine Methode, die Daten und Kontext entgegennimmt und einen Wert zurückgibt.

Kehrt zurück:

HttpsFunction & Runnable <beliebig>

https.onRequest()

Behandeln Sie HTTP-Anfragen.

Unterschrift:

export declare function onRequest(handler: (req: Request, resp: express.Response) => void | Promise<void>): HttpsFunction;

Parameter

Parameter Typ Beschreibung
Handler (req: Request, resp: express.Response) => void | Versprechen<void> Eine Funktion, die ein Anforderungs- und Antwortobjekt entgegennimmt, dieselbe Signatur wie eine Express-App.

Kehrt zurück:

HttpsFunction

https.FunctionsErrorCode

Der Satz von Firebase Functions-Statuscodes. Die Codes sind die gleichen wie die von gRPC bereitgestellten .

Mögliche Werte:

  • cancelled : Der Vorgang wurde abgebrochen (normalerweise vom Anrufer).

  • unknown : 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 . invalid-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 zu erstellen versuchten, existiert bereits.

  • permission-denied : Der Aufrufer hat keine Berechtigung, den angegebenen Vorgang auszuführen.

  • resource-exhausted : Eine Ressource ist erschöpft, möglicherweise ist ein Kontingent pro Benutzer vorhanden, 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.

  • aborted : Der Vorgang wurde abgebrochen, normalerweise aufgrund eines Parallelitätsproblems wie Transaktionsabbrüchen usw.

  • out-of-range : Der Vorgang wurde außerhalb des gültigen Bereichs versucht.

  • unimplemented : Der Vorgang ist nicht implementiert oder wird 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.

  • unavailable : 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.

  • data-loss : Nicht behebbarer Datenverlust oder -beschädigung.

  • unauthenticated : Die Anfrage verfügt nicht über gültige Authentifizierungsdaten für den Vorgang.

Unterschrift:

export type FunctionsErrorCode = "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";