Funkcje chmury dla Firebase
Funkcje
Funkcjonować | Opis |
---|---|
funkcja (aplikacja, ...) | |
getFunctions(aplikacja, regionOrCustomDomain) | Zwraca instancję Functions dla danej aplikacji. |
funkcja(funkcjeInstancja, ...) | |
connectFunctionsEmulator(funkcjeInstancja, host, port) | Zmodyfikuj tę instancję, aby komunikowała się z emulatorem Cloud Functions. Uwaga: należy to wywołać, zanim ta instancja zostanie użyta do wykonania jakichkolwiek operacji. |
httpsCallable (instancja funkcji, nazwa, opcje) | Zwraca odwołanie do wywoływalnego wyzwalacza HTTPS o podanej nazwie. |
httpsCallableFromURL(instancja funkcji, adres URL, opcje) | Zwraca odwołanie do wywoływalnego wyzwalacza HTTPS z określonym adresem URL. |
Interfejsy
Interfejs | Opis |
---|---|
Funkcje | Instancja Functions . |
FunkcjeBłąd | Błąd zwrócony przez pakiet SDK klienta Firebase Functions. |
Opcje HTTPSCallable | Interfejs dla metadanych dotyczących sposobu wykonywania wywołań. |
Wynik HTTPSCallableResult | HttpsCallableResult otacza pojedynczy wynik wywołania funkcji. |
Wpisz aliasy
Wpisz Alias | Opis |
---|---|
FunkcjeKod błędu | Zestaw kodów stanu Firebase Functions. Kody są takie same jak te ujawnione przez gRPC tutaj: https://github.com/grpc/grpc/blob/master/doc/statuscodes.md Możliwe wartości: - 'cancelled': Operacja została anulowana (zwykle przez osobę wywołującą). - „nieznany”: 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 „nieudanego warunku wstępnego”. „nieprawidłowy argument” wskazuje argumenty, które są problematyczne niezależnie od stanu systemu (np. nieprawidłowa nazwa pola). - „przekroczony termin”: 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. - „już istnieje”: jakiś dokument, który próbowaliśmy utworzyć, już istnieje. - „Odmowa uprawnień”: Osoba wywołująca nie ma uprawnień do wykonania określonej operacji. - 'zasoby wyczerpane': 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-condition': Operacja została odrzucona, ponieważ system nie jest w stanie wymaganym do wykonania operacji. - „przerwano”: operacja została przerwana, zazwyczaj z powodu problemu ze współbieżnością, np. przerwania transakcji itp. - „poza zakresem”: podjęto próbę wykonania operacji poza prawidłowym zakresem. - „niezaimplementowane”: Operacja nie jest zaimplementowana lub nie jest obsługiwana/włączona. - „wewnętrzny”: 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. - 'niedostępny': Usługa jest chwilowo niedostępna. Jest to najprawdopodobniej stan przejściowy i można go skorygować, ponawiając próbę z wycofywaniem. - „utrata danych”: nieodwracalna utrata lub uszkodzenie danych. - „nieuwierzytelnione”: żądanie nie zawiera ważnych danych uwierzytelniających dla operacji. |
FunkcjeErrorCodeCore | Ciąg kodu błędu funkcji dołączony po przedrostku produktu „functions/”. Zobacz FunctionsErrorCode , aby uzyskać pełną dokumentację kodów. |
HttpsWywoływalne | Odniesienie do „wywoływalnego” wyzwalacza 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 | Aplikacja Firebase do użycia. |
regionOrCustomDomain | strunowy | jedna z: a) regionu, w którym znajdują się wywoływalne funkcje (np. us-central1) b) niestandardowej domeny hostującej wywoływalne funkcje (np. https://mydomain.com) |
Zwroty:
funkcja(funkcjeInstancja, ...)
connectFunctionsEmulator(funkcjeInstancja, host, port)
Zmodyfikuj tę instancję, aby komunikowała się z emulatorem Cloud Functions.
Podpis:
export declare function connectFunctionsEmulator(functionsInstance: Functions, host: string, port: number): void;
Parametry
Parametr | Typ | Opis |
---|---|---|
Instancja funkcji | Funkcje | |
gospodarz | strunowy | Host emulatora (np. localhost) |
Port | numer | Port emulatora (np. 5001) |
Zwroty:
próżnia
httpsCallable (instancja funkcji, nazwa, opcje)
Zwraca odwołanie do wywoływalnego wyzwalacza 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 | strunowy | Nazwa wyzwalacza. |
opcje | Opcje HTTPSCallable |
Zwroty:
HttpsWywoływalne <Dane żądania, Dane odpowiedzi>
httpsCallableFromURL(instancja funkcji, adres URL, opcje)
Zwraca odwołanie do wywoływalnego wyzwalacza 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 | |
adres URL | strunowy | Adres URL wyzwalacza. |
opcje | Opcje HTTPSCallable |
Zwroty:
HttpsWywoływalne <Dane żądania, Dane odpowiedzi>
FunkcjeKod błędu
Zestaw kodów stanu Firebase Functions. Kody są takie same jak te ujawnione przez gRPC tutaj: https://github.com/grpc/grpc/blob/master/doc/statuscodes.md
Możliwe wartości: - 'cancelled': Operacja została anulowana (zwykle przez osobę wywołującą). - „nieznany”: 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 „nieudanego warunku wstępnego”. „nieprawidłowy argument” wskazuje argumenty, które są problematyczne niezależnie od stanu systemu (np. nieprawidłowa nazwa pola). - „przekroczony termin”: 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. - „już istnieje”: jakiś dokument, który próbowaliśmy utworzyć, już istnieje. - „Odmowa uprawnień”: Osoba wywołująca nie ma uprawnień do wykonania określonej operacji. - 'zasoby wyczerpane': 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-condition': Operacja została odrzucona, ponieważ system nie jest w stanie wymaganym do wykonania operacji. - „przerwano”: operacja została przerwana, zazwyczaj z powodu problemu ze współbieżnością, np. przerwania transakcji itp. - „poza zakresem”: podjęto próbę wykonania operacji poza prawidłowym zakresem. - „niezaimplementowane”: Operacja nie jest zaimplementowana lub nie jest obsługiwana/włączona. - „wewnętrzny”: 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. - 'niedostępny': Usługa jest chwilowo niedostępna. Jest to najprawdopodobniej stan przejściowy i można go skorygować, ponawiając próbę z wycofywaniem. - „utrata danych”: nieodwracalna utrata lub uszkodzenie danych. - „nieuwierzytelnione”: żądanie nie zawiera ważnych danych uwierzytelniających dla operacji.
Podpis:
export declare type FunctionsErrorCode = `functions/${FunctionsErrorCodeCore}`;
FunkcjeErrorCodeCore
Ciąg kodu błędu funkcji dołączony po przedrostku produktu „functions/”. Zobacz FunctionsErrorCode , aby uzyskać pełną dokumentację kodów.
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';
HttpsWywoływalne
Odniesienie do „wywoływalnego” wyzwalacza HTTP w Google Cloud Functions.
Podpis:
export declare type HttpsCallable<RequestData = unknown, ResponseData = unknown> = (data?: RequestData | null) => Promise<HttpsCallableResult<ResponseData>>;