https namespace

Funktionen

Funktion Beschreibung
onCall(opts, handler) Deklariert eine aufrufbare Methode, die Clients mithilfe eines Firebase SDK aufrufen können.
onCall(Handler) Deklariert eine aufrufbare Methode, die Clients mithilfe eines Firebase SDK aufrufen können.
onRequest(opts, handler) Verarbeitet HTTPS-Anfragen.
onRequest(handler) Verarbeitet HTTPS-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
CallableFunction Erstellt eine aufrufbare Methode, die Clients mithilfe eines Firebase SDK aufrufen können.
CallableOptions Optionen, die für eine aufrufbare HTTPS-Funktion festgelegt werden können.
CallableRequest Die Anforderung, die zum Aufrufen einer aufrufbaren Funktion verwendet wird.
HttpsOptions Optionen, die für eine onRequest-HTTPS-Funktion festgelegt werden können.
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 .
HttpsFunction Verarbeitet HTTPS-Anfragen.

https.onCall()

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

Unterschrift:

export declare function onCall<T = any, Return = any | Promise<any>>(opts: CallableOptions, handler: (request: CallableRequest<T>) => Return): CallableFunction<T, Return>;

Parameter

Parameter Typ Beschreibung
optiert CallableOptions Optionen, die für diese Funktion festgelegt werden können.
Handler (Anfrage: CallableRequest <T>) => Zurück Eine Funktion, die eine https.CallableRequest annimmt .

Kehrt zurück:

CallableFunction<T, Return>

Eine Funktion, die Sie exportieren und bereitstellen können.

https.onCall()

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

Unterschrift:

export declare function onCall<T = any, Return = any | Promise<any>>(handler: (request: CallableRequest<T>) => Return): CallableFunction<T, Return>;

Parameter

Parameter Typ Beschreibung
Handler (Anfrage: CallableRequest <T>) => Zurück Eine Funktion, die eine https.CallableRequest annimmt .

Kehrt zurück:

CallableFunction<T, Return>

Eine Funktion, die Sie exportieren und bereitstellen können.

https.onRequest()

Verarbeitet HTTPS-Anfragen.

Unterschrift:

export declare function onRequest(opts: HttpsOptions, handler: (request: Request, response: express.Response) => void | Promise<void>): HttpsFunction;

Parameter

Parameter Typ Beschreibung
optiert HttpsOptions Optionen, die für diese Funktion festgelegt werden können
Handler (Anfrage: Anfrage , Antwort: express.Response) => void | Versprechen<void> Eine Funktion, die ein https.Request- und Antwortobjekt akzeptiert, dieselbe Signatur wie eine Express-App.

Kehrt zurück:

HttpsFunction

Eine Funktion, die Sie exportieren und bereitstellen können.

https.onRequest()

Verarbeitet HTTPS-Anfragen.

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
Handler (Anfrage: Anfrage , Antwort: express.Response) => void | Versprechen<void> Eine Funktion, die ein https.Request- und Antwortobjekt akzeptiert, dieselbe Signatur wie eine Express-App.

Kehrt zurück:

HttpsFunction

Eine Funktion, die Sie exportieren und bereitstellen können.

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";

https.HttpsFunction

Verarbeitet HTTPS-Anfragen.

Unterschrift:

export type HttpsFunction = ((
req: Request, 
res: express.Response) => void | Promise<void>) & {
    __trigger?: unknown;
    __endpoint: ManifestEndpoint;
};