functions package

Cloud Functions dla Firebase

Funkcje

Funkcja Opis
function(aplikacja, ...)
getFunctions(aplikacja, regionOrCustomDomain) Zwraca instancję Functions dla danej aplikacji.
function(functionsInstance, ...)
connectFunctionsEmulator(functionsInstance, host, port) Zmodyfikuj tę instancję, aby komunikować się z emulatorem Cloud Functions.Uwaga: tę instancję należy wywołać, zanim zostanie użyta do wykonania jakichkolwiek operacji.
httpsCallable(functionsInstance, name, options) Zwraca odwołanie do wywoływanego aktywatora HTTPS o podanej nazwie.
httpsCallableFromURL(functionsInstance, url, options) Zwraca odwołanie do wywoływanego aktywatora HTTPS z określonym adresem URL.

Interfejsy

Interfejs Opis
Funkcje Instancja Functions.
Błąd funkcji Błąd zwrócony przez pakiet SDK klienta funkcji Firebase.
HttpsCallableOptions, Interfejs metadanych dotyczących sposobu wykonywania wywołań.
HttpsCallableResult HttpsCallableResult opakowuje pojedynczy wynik z wywołania funkcji.

Aliasy typu

Wpisz alias Opis
Kod błędu funkcji Zestaw kodów stanu funkcji Firebase. Kody są takie same w przypadku kodów widocznych tutaj przez gRPC: https://github.com/grpc/grpc/blob/master/doc/statuscodes.mdMożliwe wartości: – „cancelled” (anulowano): operacja została anulowana (zwykle przez wywołującego). – „Nieznany”: nieznany błąd lub błąd z innej domeny błędu. - 'invalid-argument”: klient podał nieprawidłowy argument. Pamiętaj, że to nie to samo co „niespełniony warunek wstępny”. „nieprawidłowy argument” wskazuje argumenty, które powodują problemy niezależnie od stanu systemu (np. nieprawidłowa nazwa pola). – „deadline-overeded” (przekroczono termin): upłynął 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 znaleziono): niektóre żądane dokumenty nie zostały znalezione. - „already-exists”: istnieje już dokument, który próbowaliśmy utworzyć. - „permission-denied”: element wywołujący nie ma uprawnień do wykonania określonej operacji. - „wyczerpanie zasobu”: część zasobów została wyczerpany, być może limit na użytkownika lub w całym systemie plików brakuje miejsca. – „niepowodzenie-warunek wstępny”: operacja została odrzucona, ponieważ system nie znajduje się w stanie wymaganym do jej wykonania. – „przerwano”: operacja została przerwana, zwykle z powodu problemu równoczesności, takiego jak przerwanie transakcji itp. – „poza zakresem”: podjęto próbę wykonania operacji poza prawidłowym zakresem. – „nie zaimplementowano”: 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” (niedostępna): 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.
FunctionsErrorCodeCore Ciąg kodu błędu funkcji dołączany po „functions/” prefiks usługi. Pełną dokumentację kodów znajdziesz w sekcji FunctionsErrorCode.
HttpsCallable, odwołanie do elementu „możliwe do wywołania”; Aktywator HTTP w Google Cloud Functions.

funkcja(aplikacja, ...)

getFunctions(aplikacja; regionOrCustomDomain)

Zwraca instancję Functions dla danej aplikacji.

Podpis:

export declare function getFunctions(app?: FirebaseApp, regionOrCustomDomain?: string): Functions;

Parametry

Parametr Typ Opis
aplikacja Aplikacja Firebase FirebaseApp, która ma być używana.
region lub domena niestandardowa ciąg znaków jedno z tych rozwiązań: a) region, w którym znajdują się funkcje wywoływane przez funkcje (np. us-central1), b) własna domena hostująca funkcje, które można wywołać (np. https://mojadomena.com)

Zwroty:

Funkcje

function(functionsInstance, ...)

ConnectFunctionsEmulator(functionsInstance, host, port)

Zmodyfikuj tę instancję, aby komunikować się z emulatorem Cloud Functions.

Podpis:

export declare function connectFunctionsEmulator(functionsInstance: Functions, host: string, port: number): void;

Parametry

Parametr Typ Opis
instancja funkcji Funkcje
host ciąg znaków Host emulatora (np. localhost)
port liczba Port emulatora (np. 5001).

Zwroty:

nieważne

httpsCallable(functionsInstance, name, options)

Zwraca odwołanie do wywoływanego aktywatora HTTPS o podanej nazwie.

Podpis:

export declare function httpsCallable<RequestData = unknown, ResponseData = unknown>(functionsInstance: Functions, name: string, options?: HttpsCallableOptions): HttpsCallable<RequestData, ResponseData>;

Parametry

Parametr Typ Opis
instancja funkcji Funkcje
nazwa ciąg znaków Nazwa reguły.
opcje HttpsCallableOptions,

Zwroty:

HttpsCallable<RequestData, ResponseData>

httpsCallableFromURL(functionsInstance, url, options)

Zwraca odwołanie do wywoływanego aktywatora HTTPS z określonym adresem URL.

Podpis:

export declare function httpsCallableFromURL<RequestData = unknown, ResponseData = unknown>(functionsInstance: Functions, url: string, options?: HttpsCallableOptions): HttpsCallable<RequestData, ResponseData>;

Parametry

Parametr Typ Opis
instancja funkcji Funkcje
url (adres URL) ciąg znaków Adres URL reguły.
opcje HttpsCallableOptions,

Zwroty:

HttpsCallable<RequestData, ResponseData>

Kod błędu funkcji

Zestaw kodów stanu funkcji Firebase. Kody są takie same jak te widoczne przez gRPC tutaj: https://github.com/grpc/grpc/blob/master/doc/statuscodes.md

Możliwe wartości: – „cancelled” (anulowano): operacja została anulowana (zwykle przez osobę wywołującą). – „Nieznany”: nieznany błąd lub błąd z innej domeny błędu. - 'invalid-argument”: klient podał nieprawidłowy argument. Pamiętaj, że to nie to samo co „niespełniony warunek wstępny”. „nieprawidłowy argument” wskazuje argumenty, które powodują problemy niezależnie od stanu systemu (np. nieprawidłowa nazwa pola). – „deadline-overeded” (przekroczono termin): upłynął 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 znaleziono): niektóre żądane dokumenty nie zostały znalezione. - „already-exists”: istnieje już dokument, który próbowaliśmy utworzyć. - „permission-denied”: element wywołujący nie ma uprawnień do wykonania określonej operacji. - „wyczerpanie zasobu”: część zasobów została wyczerpany, być może limit na użytkownika lub w całym systemie plików brakuje miejsca. – „niepowodzenie-warunek wstępny”: operacja została odrzucona, ponieważ system nie znajduje się w stanie wymaganym do jej wykonania. – „przerwano”: operacja została przerwana, zwykle z powodu problemu równoczesności, takiego jak przerwanie transakcji itp. – „poza zakresem”: podjęto próbę wykonania operacji poza prawidłowym zakresem. – „nie zaimplementowano”: 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” (niedostępna): 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 declare type FunctionsErrorCode = `functions/${FunctionsErrorCodeCore}`;

Rdzeń kodu błędu funkcji

Ciąg kodu błędu funkcji dołączany po „functions/” prefiks usługi. Pełną dokumentację kodów znajdziesz w sekcji FunctionsErrorCode.

Podpis:

export declare type FunctionsErrorCodeCore = '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';

Wywołanie Https

odwołanie do elementu „możliwe do wywołania”; Aktywator HTTP w Google Cloud Functions.

Podpis:

export declare type HttpsCallable<RequestData = unknown, ResponseData = unknown> = (data?: RequestData | null) => Promise<HttpsCallableResult<ResponseData>>;