https namespace

Funkcje

Zajęcia

Interfejsy

Aliasy typu

https.onCall()

Deklaruje możliwe do wywołania metodę wywoływania przez klientów za pomocą pakietu SDK Firebase.

Podpis:

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

Parametry

Zwroty:

Funkcja CallableFunction<T, Return>

Funkcja, którą można wyeksportować i wdrożyć.

https.onCall()

Deklaruje możliwe do wywołania metodę wywoływania przez klientów za pomocą pakietu SDK Firebase.

Podpis:

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

Parametry

Zwroty:

Funkcja 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

Zwroty:

HttpsFunction

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

Zwroty:

HttpsFunction

Funkcja, którą można wyeksportować i wdrożyć.

https.funkcjakodubłędu

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

Możliwe wartości:

• cancelled: operacja została anulowana (zwykle przez osobę wywołującą).

• unknown: nieznany błąd lub błąd z innej domeny błędu.

• invalid-argument: klient podał nieprawidłowy argument. Pamiętaj, że różni się to od failed-precondition. invalid-argument wskazuje argumenty, które powodują problemy niezależnie od stanu systemu (np. nieprawidłową nazwę pola).

• deadline-exceeded: minął termin przed ukończeniem operacji. W przypadku operacji, które zmieniają stan systemu, ten błąd może zostać zwrócony nawet wtedy, gdy operacja zakończyła się pomyślnie. Na przykład pomyślna odpowiedź serwera mogła być tak opóźniona, że termin upłynął.

• not-found: nie udało się znaleźć żądanego dokumentu.

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

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

• resource-exhausted: niektóre zasoby zostały wyczerpane, na przykład limit na użytkownika lub w całym systemie plików brakuje miejsca.

• failed-precondition: operacja została odrzucona, ponieważ system nie znajduje się w stanie wymaganym do jej wykonania.

• aborted: operacja została przerwana, zwykle z powodu problemu równoczesności, takiego jak przerwanie transakcji.

• out-of-range: podjęto próbę wykonania operacji poza prawidłowym zakresem.

• unimplemented: operacja nie została wdrożona lub nie jest obsługiwana/włączona.

• internal: błędy wewnętrzne. Oznacza, że pewne 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, który można rozwiązać, ponawiając próby.

• data-loss: nieodwracalna utrata lub uszkodzenie danych.

• unauthenticated: żądanie nie ma prawidłowych danych uwierzytelniających dla tej 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";

https.HttpsFunction

Obsługuje żądania HTTPS.

Podpis:

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