https namespace

Funkcje

Funkcjonować Opis
onCall (obsługa) Deklaruje metodę wywoływalną, którą klienci mogą wywoływać przy użyciu zestawu SDK Firebase.
onRequest(obsługa) Obsługuj żądania HTTP.

Zajęcia

Klasa Opis
Błąd Https Jawny błąd, który może zostać zgłoszony przez procedurę obsługi w celu wysłania błędu do klienta, który wywołał funkcję.

Interfejsy

Interfejs Opis
Kontekst wywoływalny Interfejs dla metadanych interfejsu API przekazywanych do procedury obsługi.
Wniosek Wyraźne żądanie z reprezentacją treści żądania w formacie przewodowym.

Wpisz aliasy

Wpisz Alias Opis
FunkcjeKod błędu Zestaw kodów stanu Firebase Functions. Kody są takie same jak te ujawnione przez gRPC .

https.onCall()

Deklaruje metodę wywoływalną, którą klienci mogą wywoływać przy użyciu zestawu SDK Firebase.

Podpis:

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

Parametry

Parametr Typ Opis
treser (dane: dowolne, kontekst: CallableContext ) => dowolny | Obiecaj<jakiekolwiek> Metoda pobierająca dane i kontekst i zwracająca wartość.

Zwroty:

Funkcja Https i możliwość uruchomienia <dowolny>

https.onRequest()

Obsługuj żądania HTTP.

Podpis:

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

Parametry

Parametr Typ Opis
treser (req: Request, resp: express.Response) => void | Obietnica<pusta> Funkcja pobierająca obiekt żądania i odpowiedzi z takim samym podpisem jak aplikacja Express.

Zwroty:

Funkcja Https

https.FunctionsErrorCode

Zestaw kodów stanu Firebase Functions. Kody są takie same jak te ujawnione przez gRPC .

Możliwa wartość:

  • cancelled : Operacja została anulowana (zwykle przez osobę dzwoniącą).

  • unknown : Nieznany błąd lub błąd z innej domeny błędów.

  • invalid-argument : Klient podał nieprawidłowy argument. Należy pamiętać, że różni się to od failed-precondition . invalid-argument wskazuje argumenty, które są problematyczne niezależnie od stanu systemu (np. nieprawidłowa nazwa pola).

  • deadline-exceeded : Termin upłynął przed zakończeniem operacji. W przypadku operacji zmieniających stan systemu błąd ten może zostać zwrócony nawet jeśli operacja zakończyła się pomyślnie. Na przykład pomyślna odpowiedź z serwera mogła zostać opóźniona wystarczająco długo, aby upłynął termin.

  • not-found : Nie znaleziono żądanego dokumentu.

  • already-exists : Jakiś dokument, który próbowaliśmy utworzyć, już istnieje.

  • permission-denied : Osoba wywołująca nie ma uprawnień do wykonania określonej operacji.

  • resource-exhausted : Niektóre zasoby zostały wyczerpane, być może przydział przypadający na użytkownika lub być może w całym systemie plików zabrakło miejsca.

  • failed-precondition : Operacja została odrzucona, ponieważ system nie jest w stanie wymaganym do wykonania operacji.

  • aborted : Operacja została przerwana, zazwyczaj z powodu problemu ze współbieżnością, np. przerwania transakcji itp.

  • out-of-range : Próbowano wykonać operację poza prawidłowym zakresem.

  • unimplemented : Operacja nie jest zaimplementowana lub nie jest obsługiwana/włączona.

  • internal : Błędy wewnętrzne. Oznacza, że ​​niektóre niezmienniki oczekiwane przez system bazowy zostały uszkodzone. Jeśli widzisz jeden z tych błędów, coś jest bardzo uszkodzone.

  • unavailable : Usługa jest obecnie niedostępna. Jest to najprawdopodobniej stan przejściowy i można go skorygować, ponawiając próbę z wycofywaniem.

  • data-loss : Nieodwracalna utrata lub uszkodzenie danych.

  • unauthenticated : Żądanie nie zawiera ważnych danych uwierzytelniających dla operacji.

Podpis:

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