Funkcje
Funkcjonować | Opis |
---|---|
onCall (opcje, obsługa) | Deklaruje metodę wywoływalną, którą klienci mogą wywoływać przy użyciu zestawu SDK Firebase. |
onCall (obsługa) | Deklaruje metodę wywoływalną, którą klienci mogą wywoływać przy użyciu zestawu SDK Firebase. |
onRequest(opcje, obsługa) | Obsługuje żądania HTTPS. |
onRequest(obsługa) | Obsługuje żądania HTTPS. |
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 |
---|---|
Funkcja wywoływalna | Tworzy wywoływalną metodę, którą klienci mogą wywoływać przy użyciu pakietu SDK Firebase. |
Opcje wywoływalne | Opcje, które można ustawić dla wywoływalnej funkcji HTTPS. |
Żądanie wywoływalne | Żądanie używane do wywołania funkcji wywoływalnej. |
Opcje HTTPS | Opcje, które można ustawić w funkcji HTTPS onRequest. |
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 . |
Funkcja Https | Obsługuje żądania HTTPS. |
https.onCall()
Deklaruje metodę wywoływalną, którą klienci mogą wywoływać przy użyciu zestawu SDK Firebase.
Podpis:
export declare function onCall<T = any, Return = any | Promise<any>>(opts: CallableOptions, handler: (request: CallableRequest<T>) => Return): CallableFunction<T, Return>;
Parametry
Parametr | Typ | Opis |
---|---|---|
decyduje się | Opcje wywoływalne | Opcje do ustawienia tej funkcji. |
treser | (żądanie: CallableRequest <T>) => Wróć | Funkcja pobierająca https.CallableRequest . |
Zwroty:
CallableFunction<T, Return>
Funkcja, którą można wyeksportować i wdrożyć.
https.onCall()
Deklaruje metodę wywoływalną, którą klienci mogą wywoływać przy użyciu zestawu SDK Firebase.
Podpis:
export declare function onCall<T = any, Return = any | Promise<any>>(handler: (request: CallableRequest<T>) => Return): CallableFunction<T, Return>;
Parametry
Parametr | Typ | Opis |
---|---|---|
treser | (żądanie: CallableRequest <T>) => Wróć | Funkcja pobierająca https.CallableRequest . |
Zwroty:
CallableFunction<T, Return>
Funkcja, którą można wyeksportować i wdrożyć.
https.onRequest()
Obsługuje żądania HTTPS.
Podpis:
export declare function onRequest(opts: HttpsOptions, handler: (request: Request, response: express.Response) => void | Promise<void>): HttpsFunction;
Parametry
Parametr | Typ | Opis |
---|---|---|
decyduje się | Opcje HTTPS | Opcje do ustawienia tej funkcji |
treser | (prośba: prośba , odpowiedź: express.Response) => void | Obietnica<pusta> | Funkcja pobierająca obiekt https.Request i odpowiedź z takim samym podpisem jak aplikacja Express. |
Zwroty:
Funkcja, którą można wyeksportować i wdrożyć.
https.onRequest()
Obsługuje żądania HTTPS.
Podpis:
export declare function onRequest(handler: (request: Request, response: express.Response) => void | Promise<void>): HttpsFunction;
Parametry
Parametr | Typ | Opis |
---|---|---|
treser | (prośba: prośba , odpowiedź: express.Response) => void | Obietnica<pusta> | Funkcja pobierająca obiekt https.Request i odpowiedź z takim samym podpisem jak aplikacja Express. |
Zwroty:
Funkcja, którą można wyeksportować i wdrożyć.
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 odfailed-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";
Funkcja https.Https
Obsługuje żądania HTTPS.
Podpis:
export type HttpsFunction = ((
req: Request,
res: express.Response) => void | Promise<void>) & {
__trigger?: unknown;
__endpoint: ManifestEndpoint;
};